StringCbCatNA 函数 (strsafe.h)

  • 项目

将指定数量的字节从一个字符串连接到另一个字符串。 目标缓冲区的大小（以字节为单位）提供给函数，以确保它不会写入此缓冲区的末尾。

StringCbCatN 取代了以下函数：

语法

STRSAFEAPI StringCbCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cbToAppend
);

参数

[in, out] pszDest

类型： LPTSTR

目标缓冲区，其中包含要连接到 pszSrc 的字符串，并接收生成的字符串。 pszSrc 处的字符串（最多 cbMaxAppend 字节）将添加到 pszDest 的字符串末尾。

[in] cbDest

类型： size_t

目标缓冲区的大小（以字节为单位）。 此值必须考虑 pszSrc 的长度加上 pszDest 或 cbMaxAppend 的长度， (以较小的) 加上终止 null 字符为准。 允许的最大字节数为 STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

类型： LPCTSTR

要连接到 pszDest 末尾的源字符串。 此源字符串必须以 null 结尾。

[in] cbToAppend

类型： size_t

要追加到 pszDest 的最大字节数。

返回值

类型： HRESULT

此函数可以返回以下值之一。 强烈建议使用 SUCCEEDED 和 FAILED 宏来测试此函数的返回值。

返回代码 说明
S_OK
 存在源数据，字符串连接而不截断，结果目标缓冲区以 null 结尾。
STRSAFE_E_INVALID_PARAMETER
 cbDest 中的值大于允许的最大值，或者目标缓冲区已满。
STRSAFE_E_INSUFFICIENT_BUFFER
 由于缓冲区空间不足，串联操作失败。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。 在截断是可接受的情况下，这不一定被视为失败条件。
 

请注意，此函数返回 HRESULT 值，这与它所替换的函数不同。

注解

与它替换的函数相比， StringCbCatN 为代码中的正确缓冲区处理提供了额外的处理。 不良的缓冲区处理与许多涉及缓冲区溢出的安全问题有关。 StringCbCatN 始终以 null 结尾，从不溢出有效的目标缓冲区，即使源字符串的内容在操作期间发生更改也是如此。

如果 pszSrc 和 pszDest 指向的字符串重叠，则行为未定义。

pszSrc 和 pszDest 都不应为 NULL。 如果需要处理 null 字符串指针值，请参阅 StringCbCatNEx 。

StringCbCatN 可用于其泛型形式或更具体的形式。 字符串的数据类型决定了应使用的此函数的形式。

String 数据类型 字符串 函数
char “字符串” StringCbCatNA
TCHAR TEXT (“string”) StringCbCatN
WCHAR L“string” StringCbCatNW
 

注意

strsafe.h 标头将 StringCbCatN 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 具有 SP2 的 Windows XP [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2003 SP1 [桌面应用 |UWP 应用]
目标平台 Windows
标头 strsafe.h

另请参阅

引用

StringCbCat

StringCbCatNEx

StringCchCatN