stringCchCatNA 函数 (strsafe.h)

  • 项目

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

StringCchCatN 是以下函数的替代项：

语法

STRSAFEAPI StringCchCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cchToAppend
);

参数

[in, out] pszDest

类型： LPTSTR

目标缓冲区，其中包含要与 pszSrc 连接的字符串，并将接收整个结果字符串。 pszSrc 处的字符串（最多 cchMaxAppend 字符）将添加到 pszDest 处的字符串末尾。

[in] cchDest

类型： size_t

目标缓冲区的大小（以字符为单位）。 此值必须等于 pszSrc 的长度加上 pszDest 或 cchMaxAppend () 较小者。 对于此总和，请添加 1 以考虑终止 null 字符。 允许的最大字符数是 STRSAFE_MAX_CCH。

[in] pszSrc

类型： LPCTSTR

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

[in] cchToAppend

类型： size_t

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

返回值

类型： HRESULT

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

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

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

注解

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

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

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

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

String 数据类型 字符串 函数
char “字符串” StringCchCatNA
TCHAR TEXT (“string”) StringCchCatN
WCHAR L“string” StringCchCatNW
 

注意

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

要求

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

另请参阅

引用

StringCbCatN

StringCchCat

StringCchCatNEx