RtlUnicodeStringCbCatStringNEx 函数 (ntstrsafe.h)

当目标字符串包含在UNICODE_STRING结构中时，RtlUnicodeStringCbCatStringNEx 函数连接两个字符串，同时限制追加字符串的大小。

语法

NTSTRSAFEDDI RtlUnicodeStringCbCatStringNEx(
  [in, out]       PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToAppend,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

参数

[in, out] DestinationString

可选。 指向 UNICODE_STRING 结构的指针。 此结构包括一个缓冲区，该缓冲区在输入时包含源字符串将连接到的目标字符串。 在输出中，此缓冲区是包含整个结果字符串的目标缓冲区。 源字符串 (不包括终止 null) 将添加到目标字符串的末尾。 结构的字符串缓冲区中的最大字节数为 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。 DestinationString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] pszSrc

调用方提供的指向以 null 结尾的字符串的指针。 此字符串将连接到 DestinationString 指向的UNICODE_STRING结构中包含的字符串的末尾。pszSrc 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] cbToAppend

要追加到 DestinationString 参数描述的字符串的最大字节数。

[out, optional] RemainingString

可选。 如果调用方提供指向UNICODE_STRING结构的非 NULL 指针，则该函数将此结构的 Buffer 成员设置为串联字符串的末尾，将结构的 Length 成员设置为零，并将结构的 MaximumLength 成员设置为目标缓冲区中剩余的字节数。 RemainingString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] dwFlags

一个或多个标志以及填充字节（可选）。 这些标志的定义如下：

值	含义
STRSAFE_FILL_BEHIND	如果设置了此标志并且函数成功，则 dwFlags 的低字节用于填充字符串中最后一个字符后面的目标缓冲区部分。
STRSAFE_IGNORE_NULLS	如果设置了此标志，则源指针或目标指针（或两者）可以为 NULL。 RtlUnicodeStringCbCatStringNEx 将 NULL 源缓冲区指针视为空字符串 (TEXT (“”) ) ，可以复制。 NULL 目标缓冲区指针无法接收非空字符串。
STRSAFE_FILL_ON_FAILURE	如果设置了此标志并且函数失败，则 dwFlags 的低字节用于填充整个目标缓冲区。 此操作将覆盖任何预先存在的缓冲区内容。
STRSAFE_NULL_ON_FAILURE	如果设置了此标志并且函数失败，则目标缓冲区将设置为空字符串 (TEXT (“”) ) 。 此操作将覆盖任何预先存在的缓冲区内容。
STRSAFE_NO_TRUNCATION	如果设置了此标志，并且函数返回 STATUS_BUFFER_OVERFLOW： 如果还指定了STRSAFE_FILL_ON_FAILURE，STRSAFE_NO_TRUNCATION相应地填充目标缓冲区。 否则，目标缓冲区将未修改。
STRSAFE_ZERO_LENGTH_ON_FAILURE	如果设置了此标志并且函数返回STATUS_BUFFER_OVERFLOW，则目标字符串长度设置为零字节。

返回值

RtlUnicodeStringCbCatStringNEx 返回以下 NTSTATUS 值之一。

返回代码	说明
STATUS_SUCCESS	此 成功 状态表示存在源数据，并且字符串连接时未截断。
STATUS_BUFFER_OVERFLOW	此 警告 状态意味着连接操作由于目标缓冲区中的空间不足而未完成。 如果设置了 STRSAFE_NO_TRUNCATION ，请参阅 dwFlags 参数了解详细信息。
STATUS_INVALID_PARAMETER	此错误状态意味着函数收到了无效的输入参数。 有关详细信息，请参阅以下列表。

发生以下任一情况时，RtlUnicodeStringCbCatStringNEx 将返回STATUS_INVALID_PARAMETER值：

• UNICODE_STRING结构的内容无效。
• dwFlags 中指定了无效标志。
• 目标缓冲区已满。
• 缓冲区指针为 NULL ，并且未指定STRSAFE_IGNORE_NULLS标志。
• 目标缓冲区指针为 NULL，但缓冲区大小不为零。
• 目标缓冲区指针为 NULL，或其长度为零，但存在非零长度源字符串。
• cbToAppend 参数的值大于 NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR)。

有关如何测试 NTSTATUS 值的信息，请参阅 使用 NTSTATUS 值。

注解

**RtlUnicodeStringCbCatStringNEx **函数使用目标缓冲区的大小来确保串联操作不会写入缓冲区末尾。 默认情况下，函数 不会 以 null 字符值 (即零) 终止结果字符串。 作为选项，调用方可以使用STRSAFE_FILL_BEHIND标志和零的填充字节值来为 null 终止不占用整个目标缓冲区的结果字符串。

RtlUnicodeStringCbCatStringNEx 通过返回标识目标字符串末尾的UNICODE_STRING结构以及该字符串中未使用的字节数，将添加到 RtlUnicodeStringCbCatStringN 函数的功能中。 可以将标志传递给 RtlUnicodeStringCbCatStringNEx ，以便进行其他控制。

如果源字符串和目标字符串重叠，则函数的行为未定义。

除非在 dwFlags 中设置了STRSAFE_IGNORE_NULLS标志，否则 pszSrc 和 DestinationString 指针不能为 NULL。 如果设置了STRSAFE_IGNORE_NULLS，则其中一个或两个指针可以为 NULL。 如果 DestinationString 指针为 NULL， 则 pszSrc 指针必须为 NULL 或指向空字符串。

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

要求

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

另请参阅

• RtlUnicodeStringCbCatStringN
• RtlUnicodeStringCchCatStringNEx
• UNICODE_STRING