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

本文链接：https://blog.csdn.net/wangqiulin123456/article/details/8193933

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

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

strcpy, wcscpy, _tcscpy

lstrcpy

StrCpy

StringCbCopy函数原型如下：

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

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

S_OK //一切OK

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

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

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

扩展函数StringCbCopyEx原型如下：

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

其中dwFlags可取值如下：

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

函数返回值同StringCbCopy。

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

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

HRESULT StringCchCopy(
  __out  LPTSTR pszDest,
  __in   size_t cchDest, //pszDest的大小（字符数）
  __in   LPCTSTR pszSrc
);

HRESULT StringCchCopyEx(
  __out      LPTSTR pszDest,
  __in       size_t cchDest, //pszDest的大小（字符数）
  __in       LPCTSTR pszSrc,
  __out_opt  LPTSTR *ppszDestEnd,
  __out_opt  size_t *pcchRemaining,
  __in       DWORD dwFlags
);

用法举例：

获取当前目录，在没有使用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;
}

字符编码与数据类型

编码

字节数

类型

字符(串)常量

WinNT.h中的定义

ANSI

8bit

char

'A'

"A string"

typedef char CHAR;