RtlStringCbCatNA 函数 (ntstrsafe.h)

RtlStringCbCatNWRtlStringCbCatNA 函数连接两个字节计数字符串,同时限制追加字符串的大小。

语法

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

参数

[in, out] pszDest

指向缓冲区的指针,该缓冲区包含一个以 null 结尾的字符串,pszSrc 将被连接。 在输出中,这是包含整个结果字符串的目标缓冲区。 pszSrc(最多 cbToAppend 字节)处的字符串将添加到 pszDest 处的字符串末尾,以 null 字符结尾。

[in] cbDest

目标缓冲区的大小(以字节为单位)。 缓冲区必须足够大,才能同时包含字符串和终止 null 字符。

对于 Unicode 字符串,最大字节数NTSTRSAFE_MAX_CCH * sizeof(WCHAR)。

对于 ANSI 字符串,最大字节数为 NTSTRSAFE_MAX_CCH * sizeof(char)。

[in] pszSrc

指向以 null 结尾的字符串的指针。 此字符串将连接到 pszDest缓冲区中包含的字符串的末尾。

cbToAppend

要追加到缓冲区中包含的字符串的最大字节数 pszDest

返回值

该函数返回下表中列出的 NTSTATUS 值之一。 有关如何测试 NTSTATUS 值的信息,请参阅 使用 NTSTATUS 值

返回代码 描述
STATUS_SUCCESS
成功 状态意味着源数据存在,字符串在没有截断的情况下串联,生成的目标缓冲区为 null 终止。
STATUS_BUFFER_OVERFLOW
警告 状态意味着串联作由于缓冲区空间不足而未完成。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。
STATUS_INVALID_PARAMETER
错误 状态意味着函数收到了无效的输入参数。 有关详细信息,请参阅以下段落。

此函数在以下情况下返回STATUS_INVALID_PARAMETER值:

  • cbDest 中的值大于最大缓冲区大小。
  • 目标缓冲区已满。
  • 存在 NULL 指针。
  • 目标缓冲区的长度为零,但存在非零长度源字符串。

言论

应使用 RtlStringCbCatNWRtlStringCbCatNA,而不是以下函数:

  • strncat
  • wcsncat
目标缓冲区的大小(以字节为单位)提供给 RtlStringCbCatNWRtlStringCbCatNA 以确保它们不会写入缓冲区末尾。

使用 RtlStringCbCatNW 处理 Unicode 字符串,并使用 RtlStringCbCatNA 来处理 ANSI 字符串。 使用的表单取决于你的数据,如下表所示

字符串数据类型 字符串文本 功能
WCHAR L“string” RtlStringCbCatNW
char “string” RtlStringCbCatNA
 

如果 pszSrcpszDest 指向重叠字符串,则函数的行为是未定义的。

pszSrcpszDest 都不能 NULL。 如果需要处理 NULL 字符串指针值,请使用 RtlStringCbCatNEx

有关安全字符串函数的详细信息,请参阅 使用安全字符串函数

要求

要求 价值
最低支持的客户端 在 Windows XP 中提供 Service Pack 1(SP1)和更高版本的 Windows。
目标平台 桌面
标头 ntstrsafe.h (包括 Ntstrsafe.h)
Ntstrsafe.lib
IRQL 如果正在作的字符串始终驻留在内存中,则为任何字符串,否则PASSIVE_LEVEL

另请参阅

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN