StringCchCatA 函数 (strsafe.h)

将一个字符串连接到另一个字符串。 目标缓冲区的大小提供给函数,以确保 StringCchCat 不会写入此缓冲区的末尾。

StringCchCat 替代以下函数:

语法

STRSAFEAPI StringCchCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_LPCSTR pszSrc
);

参数

[in, out] pszDest

类型:LPTSTR

目标缓冲区,其中包含 pszSrc 要连接的字符串,该缓冲区将接收整个结果字符串。 pszSrc 处的字符串将添加到 pszDest处的字符串末尾。

[in] cchDest

类型:size_t

目标缓冲区的大小(以字符为单位)。 此值必须大于或等于 pszSrc 的长度 加上 pszDest 加上 1 的长度,以同时考虑字符串和终止 null 字符。 允许的最大字符数为 STRSAFE_MAX_CCH。

[in] pszSrc

类型:LPCTSTR

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

返回值

类型:HRESULT

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

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

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

言论

StringCchCat 为代码中的正确缓冲区处理提供其他处理。 缓冲区处理不当与涉及缓冲区溢出的许多安全问题有关。 StringCchCat 始终为 null 终止,并且永远不会溢出有效的目标缓冲区,即使源字符串的内容在操作期间发生更改。

如果 pszSrc 指向的字符串 与 pszDest 重叠,则行为是不确定的。

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

StringCchCat 可用于其泛型形式或更具体的窗体。 字符串的数据类型确定应使用的此函数的形式,如下表所示。

字符串数据类型 字符串文本 功能
char “string” StringCchCatA
TCHAR TEXT(“string”) StringCchCat
WCHAR L“string” StringCchCatW
 

注意

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

要求

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

另请参阅

参考

StringCbCat

StringCchCatEx

StringCchCatN