windows核心编程---StringCbCopy和StringCchCopy 函数

转载自：http://blog.youkuaiyun.com/wangqiulin123456/article/details/8193933

StringCbCopy函数用于拷贝string，且提供了目标缓冲区的大小作为参数，防止缓冲区溢出等安全问题。

这个函数可用于替换以下函数的使用：

strcpy, wcscpy, _tcscpy

lstrcpy

StrCpy

StringCbCopy函数原型如下：

[cpp]  view plain copy print ?

1. HRESULT StringCbCopy(  
2.   __out  LPTSTR pszDest, //目标字符串缓冲区  
3.   __in   size_t cbDest, //目标缓冲区大小（字节），这个值必须考虑pszSrc加上空结束符’/0’的大小；  
4.                             //最大运行的字节数是STRSAFE_MAX_CCH * sizeof(TCHAR)  
5.   __in   LPCTSTR pszSrc //源字符串缓冲区，必须以’/0’结尾  
6. );  

函数返回值如下（强烈建议使用SUCCEEDED和FAILED宏来测试返回值）：

S_OK                 //一切OK

STRSAFE_E_INVALID_PARAMETER    //目标缓冲区中值的大小要么是0，要么大于最大允许值

STRSAFE_E_INSUFFICIENT_BUFFER  //目标缓冲区大小不够，数据被截断；

//当允许数据截断时，这不算是错误

 

扩展函数StringCbCopyEx原型如下：

[cpp]  view plain copy print ?

1. HRESULT StringCbCopyEx(  
2.   __out      LPTSTR pszDest, //目标字符串缓冲区  
3.   __in       size_t cbDest, //pszDest的大小（字节）  
4.   __in       LPCTSTR pszSrc, //源字符串缓冲区  
5.   __out_opt  LPTSTR *ppszDestEnd, //指向pszDest结尾的指针（指向空结束符处）  
6.   __out_opt  size_t *pcbRemaining, //pszDest未使用的字节数，包括空结束符占用的字节  
7.   __in       DWORD dwFlags //取值见下文  
8. );  

其中dwFlags可取值如下：

[cpp]  view plain copy print ?

1. STRSAFE_FILL_BEHIND_NULL             //函数执行成功时，dwFlag(0)的低字节将被用于填充  
2. //pszDest的'/0'之后的未被填充的空间  
3. STRSAFE_IGNORE_NULLS  //将空字符串指针（null）以空字符串TEXT("")对待，可用于模拟lstrcpy  
4. STRSAFE_FILL_ON_FAILURE       //函数执行失败时，dwFlag(0)的低字节将被用于填充  
5. //pszDest所有的空间，且pszDest以空结束符结束  
6. STRSAFE_NULL_ON_FAILURE //函数执行失败时，pszDest被设置为空字符串TEXT("")  
7. STRSAFE_NO_TRUNCATION     //不截断  

函数返回值同StringCbCopy。

 

还有两个相似的函数分别是StringCchCopy和StringCchCopyEx，它们和上面两个函数唯一的区别是StringCchCopy函数是以字符数计数的，而StringCbCopy函数是以字节数计数的。

（ch表示character；b表示byte），这两个函数原型如下：

[cpp]  view plain copy print ?

1. HRESULT StringCchCopy(  
2.   __out  LPTSTR pszDest,  
3.   __in   size_t cchDest, //pszDest的大小（字符数）  
4.   __in   LPCTSTR pszSrc  
5. );  

[cpp]  view plain copy print ?

1. HRESULT StringCchCopyEx(  
2.   __out      LPTSTR pszDest,  
3.   __in       size_t cchDest, //pszDest的大小（字符数）  
4.   __in       LPCTSTR pszSrc,  
5.   __out_opt  LPTSTR *ppszDestEnd,  
6.   __out_opt  size_t *pcchRemaining,  
7.   __in       DWORD dwFlags  
8. );  

用法举例：

获取当前目录，在没有使用strSafe系列函数之前，经典的用法是：

[plain]  view plain copy print ?

1. void UnsafeFunc(LPTSTR szPath,DWORD cchPath) {  
2.          TCHAR szCWD[MAX_PATH];  
3.          GetCurrentDirectory(ARRAYSIZE(szCWD), szCWD);  
4.          strncpy(szPath, szCWD, cchPath);       //没有检查返回值  
5.          strncat(szPath, TEXT("//"), cchPath);  
6.          strncat(szPath, TEXT("asce.ini"),cchPath);  
7. }  

使用strSafe系列函数之后，提高了字符串处理的安全性：

[cpp]  view plain copy print ?

1. bool SaferFunc(LPTSTR szPath,DWORD cchPath) {  
2.     TCHAR szCWD[MAX_PATH];  
3.     if (GetCurrentDirectory(ARRAYSIZE(szCWD), szCWD) &&  
4.         SUCCEEDED(StringCchCopy(szPath, cchPath, szCWD)) &&  
5.         SUCCEEDED(StringCchCat(szPath, cchPath, TEXT("//"))) &&  
6.         SUCCEEDED(StringCchCat(szPath, cchPath, TEXT("asce.ini")))) {  
7.             return true;  
8.     }  
9.     return false;  
10. }  

字符编码与数据类型

编码	字节数	类型	字符(串)常量	WinNT.h中的定义
ANSI	8bit	char	'A' "A string"	typedef char CHAR; typedef CHAR *PCHAR; typedef CHAR *PSTR; typedef CONST CHAR *PCSTR;
Unicode (UTF-16)	16bit	wchar_t 通过编译器设置/Zc:wchar_t支持	L'A' L"A string"	typedef wchar_t WCHAR; typedef WCHAR *PWCHAR; typedef WCHAR *PWSTR; typedef CONST WCHAR *PCWSTR;

WinNT.h头文件中定义字符类型宏，TCHAR、PTCHAR、PTSTR、PCTSTR、TEXT()，可在ANSI和Unicode编码间通用。