StringCbCopy函数用于拷贝string,且提供了目标缓冲区的大小作为参数,防止缓冲区溢出等安全问题。
这个函数可用于替换以下函数的使用:
strcpy, wcscpy, _tcscpy,lstrcpy,StrCpy
StringCbCopy函数原型如下:
HRESULT StringCbCopy(
__out LPTSTR pszDest, //目标字符串缓冲区
__in size_t cbDest, //目标缓冲区大小(字节),这个值必须考虑pszSrc加上空结束符’/0’的大小;
__in LPCTSTR pszSrc //源字符串缓冲区,必须以’/0’结尾
);
函数返回值如下(强烈建议使用SUCCEEDED和FAILED宏来测试返回值):
S_OK //一切OK
STRSAFE_E_INVALID_PARAMETER //目标缓冲区中值的大小要么是0,要么大于最大允许值
STRSAFE_E_INSUFFICIENT_BUFFER //目标缓冲区大小不够,数据被截断;
//当允许数据截断时,这不算是错误
StringCbCopy函数根据传入的字符串参数类型而自动调用不同的函数:
//字符串类型 字符串实例 自动调用的函数
char "ASCE" StringCbCopyA
TCHAR TEXT("ASCE") StringCbCopy
WCHAR L"ASCE" StringCbCopyW
还有个相似的函数StringCchCopy,它和上面两个函数唯一的区别是StringCchCopy函数是以字符数计数的,而StringCbCopy函数是以字节数计数的。
(ch表示character;b表示byte),这两个函数原型如下:
HRESULT StringCchCopy(
__out LPTSTR pszDest,
__in size_t cchDest, //pszDest的大小(字符数)
__in LPCTSTR pszSrc
);
用法举例:
获取当前目录,在没有使用strSafe系列函数之前,经典的用法是:
void UnsafeFunc(LPTSTR szPath,DWORD cchPath) {
TCHAR szCWD[MAX_PATH];
GetCurrentDirectory(ARRAYSIZE(szCWD), szCWD);
strncpy(szPath, szCWD, cchPath); //没有检查返回值
strncat(szPath, TEXT("//"), cchPath);
strncat(szPath, TEXT("asce.ini"),cchPath);
}
使用strSafe系列函数之后,提高了字符串处理的安全性:
bool SaferFunc(LPTSTR szPath,DWORD cchPath) {
TCHAR szCWD[MAX_PATH];
if (GetCurrentDirectory(ARRAYSIZE(szCWD), szCWD) &&
SUCCEEDED(StringCchCopy(szPath, cchPath, szCWD)) &&
SUCCEEDED(StringCchCat(szPath, cchPath, TEXT("//"))) &&
SUCCEEDED(StringCchCat(szPath, cchPath, TEXT("asce.ini")))) {
return true;
}
return false;
}