stringCbCopyA 函数 (strsafe.h)
将一个字符串复制到另一个字符串。 向函数提供目标缓冲区的大小,以确保它不会写入此缓冲区的末尾。
StringCbCopy 是以下函数的替代项:
语法
STRSAFEAPI StringCbCopyA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCSTR pszSrc
);
参数
[out] pszDest
类型: LPTSTR
接收复制字符串的目标缓冲区。
[in] cbDest
类型: size_t
目标缓冲区的大小(以字节为单位)。 此值必须考虑 pszSrc 的长度加上终止 null 字符。 允许的最大字节数为 STRSAFE_MAX_CCH * sizeof(TCHAR)
。
[in] pszSrc
类型: LPCTSTR
指向包含源字符串的缓冲区的指针。 此源字符串必须以 null 结尾。
返回值
类型: HRESULT
此函数可以返回以下值之一。 强烈建议使用 SUCCEEDED 和 FAILED 宏来测试此函数的返回值。
返回代码 | 说明 |
---|---|
|
源数据存在,完全复制且未截断,结果目标缓冲区以 null 结尾。 |
|
cbDest 中的值小于sizeof(TCHAR) 或大于允许的最大值。
|
|
由于缓冲区空间不足,复制操作失败。 目标缓冲区包含截断的、以 null 结尾的预期结果版本。 在可以接受截断的情况下,这可能不一定被视为故障条件。 |
请注意,此函数返回 HRESULT 值,与它替换的函数不同。
注解
与它替换的函数相比, StringCbCopy 为代码中的正确缓冲区处理提供了额外的处理。 糟糕的缓冲区处理与涉及缓冲区溢出的许多安全问题有关。 StringCbCopy 始终以 null 结尾,从不溢出有效的目标缓冲区,即使源字符串的内容在操作期间发生更改也是如此。
如果 pszSrc 和 pszDest 指向的字符串重叠,则行为未定义。
pszSrc 和 pszDest 都不应为 NULL。 如果需要处理 null 字符串指针值,请参阅 StringCbCopyEx 。
StringCbCopy 可以采用其泛型形式或更具体的形式使用。 字符串的数据类型决定了应使用的此函数的形式。
String 数据类型 | 字符串 | 函数 |
---|---|---|
char | “字符串” | StringCbCopyA |
TCHAR | TEXT (“string”) | StringCbCopy |
WCHAR | L“string” | StringCbCopyW |
注意
strsafe.h 标头将 StringCbCopy 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows XP SP2 [桌面应用 |UWP 应用] |
最低受支持的服务器 | Windows Server 2003 SP1 [桌面应用 |UWP 应用] |
目标平台 | Windows |
标头 | strsafe.h |
另请参阅
引用