RtlStringCbCatNExA 函数 （ntstrsafe.h）

  • 项目

RtlStringCbCatNExW 和 RtlStringCbCatNExA 函数连接两个字节计数字符串，同时限制追加字符串的大小。

语法

NTSTRSAFEDDI RtlStringCbCatNExA(
  [in, out, optional] NTSTRSAFE_PSTR pszDest,
  [in]                size_t         cbDest,
  [in, optional]      STRSAFE_PCNZCH pszSrc,
                      size_t         cbToAppend,
  [out, optional]     NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional]     size_t         *pcbRemaining,
  [in]                DWORD          dwFlags
);

参数

[in, out, optional] pszDest

指向缓冲区的指针，该缓冲区包含一个以 null 结尾的字符串，pszSrc 将被连接。 在输出中，这是包含整个结果字符串的目标缓冲区。 pszSrc处的字符串（最多 cbMaxAppend 字节）将添加到 pszDest处的字符串末尾，以 null 字符结尾。 pszDest 指针可以 NULL，但前提是STRSAFE_IGNORE_NULLS在 dwFlags中设置 。

[in] cbDest

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

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

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

如果 pszDest 为 NULL，则 cbDest 必须为零。

[in, optional] pszSrc

指向以 null 结尾的字符串的指针。 此字符串将连接到 pszDest缓冲区中包含的字符串的末尾。 pszSrc 指针可以 NULL，但前提是STRSAFE_IGNORE_NULLS在 dwFlags 中设置。

cbToAppend

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

[out, optional] ppszDestEnd

如果调用方提供非NULL 地址指针，则在串联操作完成后，该函数会加载该地址，该地址与目标缓冲区生成的 NULL 字符串终止符 。

[out, optional] pcbRemaining

如果调用方提供非NULL 地址指针，则该函数将加载地址，该地址包含由 pszDest指向的缓冲区中未使用的字节数，包括用于终止 null 字符的字节数。

[in] dwFlags

一个或多个标志，还可以选择填充字节。 标志的定义如下：

价值 意义
STRSAFE_FILL_BEHIND_NULL 如果设置此标志并且函数成功，则 dwFlags 的低字节用于填充终止 null 字符之后的目标缓冲区部分。
STRSAFE_IGNORE_NULLS 如果设置了此标志，pszDest 或 pszSrc或两者都可以 NULL。 NULLpszSrc 指针被视为可以复制的空字符串（TEXT（“”）。 NULLpszDest 指针无法接收无空字符串。
STRSAFE_FILL_ON_FAILURE 如果设置了此标志并且函数失败，则 dwFlags 的低字节用于填充整个目标缓冲区，并且缓冲区以 null 结尾。 此操作覆盖任何预先存在的缓冲区内容。
STRSAFE_NULL_ON_FAILURE 如果设置了此标志并且函数失败，则目标缓冲区将设置为空字符串（TEXT（“”）。 此操作覆盖任何预先存在的缓冲区内容。
STRSAFE_NO_TRUNCATION

如果设置了此标志，并且函数返回 STATUS_BUFFER_OVERFLOW：

  • 如果还指定了 STRSAFE_FILL_ON_FAILURE，则 STRSAFE_NO_TRUNCATION 相应地填充目标缓冲区。
  • 否则，目标缓冲区将未修改。

返回值

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

返回代码 描述
STATUS_SUCCESS 此 成功 状态意味着源数据存在，字符串完全连接而不截断，结果目标缓冲区为 null 终止。
STATUS_BUFFER_OVERFLOW 此 警告 状态意味着复制操作由于目标缓冲区中的空间不足而未完成。 如果设置了 STRSAFE_NO_TRUNCATION，请参阅 dwFlags 参数了解详细信息。
STATUS_INVALID_PARAMETER

此 错误 状态意味着函数收到了无效的输入参数。 有关详细信息，请参阅以下段落。

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

  • 指定了无效标志。
  • cbDest 中的值大于最大缓冲区大小。
  • 目标缓冲区已满。
  • 不存在没有 STRSAFE_IGNORE_NULLS 标志的 NULL 指针。
  • 目标缓冲区指针 NULL，但缓冲区大小不为零。
  • 目标缓冲区指针 NULL，或者其长度为零，但存在非零长度源字符串。

言论

应使用 RtlStringCbCatNExW 和 RtlStringCbCatNExA，而不是以下函数：

  • strncat
  • wcsncat

目标缓冲区的大小（以字节为单位）提供给 RtlStringCbCatNExW，RtlStringCbCatNExA 以确保它们不会写入缓冲区末尾。

RtlStringCbCatNEx 通过返回指向目标字符串末尾的指针以及该字符串中未使用的字节数来添加到 RtlStringCbCatN 的功能。 可以将标志传递给函数以获取其他控件。

使用 RtlStringCbCatNExW 来处理 Unicode 字符串，并使用 RtlStringCbCatNExA 来处理 ANSI 字符串。 所使用的窗体取决于你的数据，如下表所示。

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

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

除非设置了STRSAFE_IGNORE_NULLS标志，否则 pszSrc 或 pszDest 都不能 NULL，在这种情况下，两者都可以 NULL。 如果 pszDestNULL，pszSrc 必须 NULL 或指向空字符串。

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

要求

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

另请参阅