RtlStringCbCatA 函数 (ntstrsafe.h)

  • 项目

RtlStringCbCatW 和 RtlStringCbCatA 函数连接两个字节计数的字符串。

语法

NTSTRSAFEDDI RtlStringCbCatA(
  [in, out] NTSTRSAFE_PSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      NTSTRSAFE_PCSTR pszSrc
);

参数

[in, out] pszDest

指向缓冲区的指针，该缓冲区在输入时包含以 null 结尾的字符串， pszSrc 将连接到该字符串。 在输出中，这是包含整个结果字符串的目标缓冲区。 pszSrc 中的字符串将添加到 pszDest 的字符串末尾，并用 null 字符结尾。

[in] cbDest

目标缓冲区的大小（以字节为单位）。 目标缓冲区必须足够大，才能包含串联的字符串和终止 null 字符。

对于 Unicode 字符串，最大字节数为 NTSTRSAFE_MAX_CCH * size of (WCHAR) 。

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

[in] pszSrc

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

返回值

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

返回代码 说明
STATUS_SUCCESS
 此 成功 状态表示源数据已存在，字符串连接而不截断，结果目标缓冲区以 null 结尾。
STATUS_BUFFER_OVERFLOW
 此 警告 状态意味着串联操作由于缓冲区空间不足而未完成。 目标缓冲区包含预期结果的截断、以 null 结尾的版本。
STATUS_INVALID_PARAMETER
 此错误状态表示函数收到了无效的输入参数。 有关详细信息，请参阅以下段落。

STATUS_INVALID_PARAMETER返回值表示发生了以下情况之一：

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

注解

应使用 RtlStringCbCatW 和 RtlStringCbCatA，而不是以下函数：

  • strcat
  • wcscat
由于 RtlStringCbCatW 和 RtlStringCbCatA 接收目标缓冲区的大小作为输入，因此它们不会写入缓冲区末尾。

使用 RtlStringCbCatW 处理 Unicode 字符串，使用 RtlStringCbCatA 处理 ANSI 字符串。 要使用的窗体由你的数据决定，如下表所示。

字符串数据类型 字符串文本 函数
WCHAR L“string” RtlStringCbCatW
char “字符串” RtlStringCbCatA
 

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

pszSrc 和 pszDest 都不能为 NULL。 如果需要处理 NULL 字符串指针值，请使用 RtlStringCbCatNEx。

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

要求

要求 值
最低受支持的客户端 在 Windows XP 中提供 Service Pack 1 (SP1) 及更高版本的 Windows。
目标平台 桌面
标头 ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另请参阅

RtlStringCbCatEx

RtlStringCbCatNEx

RtlStringCchCatEx