StringCbCopyNExA 函数 (strsafe.h)
将指定的字节数从一个字符串复制到另一个字符串。 目标缓冲区的大小提供给函数,以确保它不会写入到此缓冲区的末尾。
StringCbCopyNEx 通过返回指向目标字符串末尾的指针以及该字符串中未使用的字节数,从而增加了 StringCbCopyN 的功能。 还可以将标志传递给函数以获取其他控件。
StringCbCopyNEx 替代以下函数:
语法
STRSAFEAPI StringCbCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
参数
[out] pszDest
类型:LPTSTR
接收复制字符串的目标缓冲区。
[in] cbDest
类型:size_t
pszDest的大小(以字节为单位)。 此值必须至少足够大才能容纳复制的字节(pszSrc 的长度 或 cbSrc的值,以考虑终止 null 字符。 允许的最大字节数是 STRSAFE_MAX_CCH * sizeof(TCHAR)
。
[in] pszSrc
类型:LPCTSTR
源字符串。 此字符串必须以 null 结尾。
[in] cbToCopy
类型:size_t
要从 pszSrc 复制到 pszDest的最大字节数。
[out, optional] ppszDestEnd
类型:LPTSTR*
指向 pszDest末尾的指针的地址。 如果 ppszDestEnd 为非NULL,并且任何数据都复制到目标缓冲区中,则指向字符串末尾的终止 null 字符。
[out, optional] pcbRemaining
类型:size_t*
pszDest中未使用的字节数,包括用于终止 null 字符的字节数。 如果 NULL,则不会保留或返回计数。
[in] dwFlags
类型:DWORD
以下一个或多个值。
返回值
类型:HRESULT
此函数可以返回以下值之一。 强烈建议使用 SUCCEEDED,并 失败 宏来测试此函数的返回值。
返回代码 | 描述 |
---|---|
|
源数据存在,未截断完全复制,生成的目标缓冲区为 null 终止。 |
|
pszDest 或 pszSrc 大于 STRSAFE_MAX_CCH * sizeof(TCHAR) ,pszDest 在存在要复制的源数据时 NULL,或者传递了无效标志。
|
|
复制操作由于缓冲区空间不足而失败。 根据 dwFlags的值,目标缓冲区可能包含被截断的、以 null 结尾的预期结果版本。 在截断是可接受的情况下,这不一定被视为失败条件。 |
请注意,此函数返回 HRESULT 值,这与它替换的函数不同。
言论
StringCbCopyNEx 为代码中的正确缓冲区处理提供其他处理。 缓冲区处理不当与涉及缓冲区溢出的许多安全问题有关。 StringCbCopyNEx 始终为 null 终止,并且永远不会溢出有效的目标缓冲区,即使源字符串的内容在操作期间发生更改也是如此。
虽然此例程旨在替代 strncpy,但行为存在差异。 如果
如果 pszSrc 指向的字符串 与 pszDest 重叠,则行为是不确定的。
除非指定 STRSAFE_IGNORE_NULLS 标志,否则 pszSrc 和 pszDest 都不应 NULL,在这种情况下,两者都可能 NULL。 但是,即使忽略了 NULL 值
StringCbCopyNEx 可用于其泛型形式或更具体的窗体。 字符串的数据类型确定应使用的此函数的形式,如下表所示。
字符串数据类型 | 字符串文本 | 功能 |
---|---|---|
char | “string” | StringCbCopyNExA |
TCHAR | TEXT(“string”) | StringCbCopyNEx |
WCHAR | L“string” | StringCbCopyNExW |
注意
strsafe.h 标头将 StringCbCopyNEx 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的
要求
要求 | 价值 |
---|---|
最低支持的客户端 | 带 SP2 的 Windows XP [桌面应用 |UWP 应用] |
支持的最低服务器 | Windows Server 2003 SP1 [桌面应用 |UWP 应用] |
目标平台 | 窗户 |
标头 | strsafe.h |
另请参阅
参考