RtlUnicodeStringPrintfEx 函数 (ntstrsafe.h)

项目
05/03/2024

RtlUnicodeStringPrintfEx 函数创建一个文本字符串，其格式基于提供的格式设置信息，并将字符串存储在UNICODE_STRING结构中。

语法

NTSTRSAFEDDI RtlUnicodeStringPrintfEx(
  [out]           PUNICODE_STRING  DestinationString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

参数

[out] DestinationString

可选。指向接收格式化字符串 的UNICODE_STRING 结构的指针。 RtlUnicodeStringPrintfEx 从 pszFormat 指定的格式字符串和函数的参数列表创建此字符串。字符串中的最大字符数为NTSTRSAFE_UNICODE_STRING_MAX_CCH。 DestinationString 可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[out, optional] RemainingString

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

[in] dwFlags

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

STRSAFE_FILL_BEHIND

如果设置了此标志并且函数成功，则 dwFlags 的低字节用于填充字符串中最后一个字符后面的目标缓冲区部分。

STRSAFE_IGNORE_NULLS

如果设置了此标志，则源指针或目标指针（或两者）可以为 NULL。 RtlUnicodeStringPrintfEx 将 NULL 源缓冲区指针视为空字符串 (TEXT (“”) ) ，可以复制。 NULL 目标缓冲区指针无法接收非空字符串。

STRSAFE_FILL_ON_FAILURE

如果设置了此标志并且函数失败，则 dwFlags 的低字节用于填充整个目标缓冲区。此操作将覆盖任何预先存在的缓冲区内容。

STRSAFE_NULL_ON_FAILURE

如果设置了此标志并且函数失败，则目标缓冲区将设置为空字符串 (TEXT (“”) ) 。此操作将覆盖任何预先存在的缓冲区内容。

STRSAFE_NO_TRUNCATION

如果设置了此标志并且函数返回STATUS_BUFFER_OVERFLOW，则不会修改目标缓冲区的内容。

STRSAFE_ZERO_LENGTH_ON_FAILURE

如果设置了此标志并且函数返回STATUS_BUFFER_OVERFLOW，则目标字符串长度设置为零字节。

[in] pszFormat

指向包含 printf 样式格式指令的以 null 结尾的文本字符串的指针。此指针可以为 NULL，但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

...

可选。 RtlUnicodeStringPrintfEx 解释的参数列表，基于 pszFormat 字符串指定的格式设置指令。

返回值

RtlUnicodeStringPrintfEx 返回以下 NTSTATUS 值之一。

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

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

UNICODE_STRING结构的内容无效。
dwFlags 中指定了无效标志。
目标缓冲区已满。
缓冲区指针为 NULL ，并且未在 dwFlags 中指定STRSAFE_IGNORE_NULLS标志。
目标缓冲区指针为 NULL，但缓冲区大小不为零。
目标缓冲区指针为 NULL，或其长度为零，但存在非零长度源字符串。

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

注解

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

RtlUnicodeStringPrintfEx 通过返回标识目标字符串末尾的UNICODE_STRING结构以及该字符串中剩余未使用的字节数，为 RtlUnicodeStringPrintf 函数的功能添加了功能。可以将标志传递给 RtlUnicodeStringPrintfEx 以获得更多控制。

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

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

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

要求

要求	值
最低受支持的客户端	从 Windows XP 开始提供 Service Pack 1 (SP1) 。
目标平台	桌面
标头	ntstrsafe.h (包括 Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL	如果正在操作的字符串始终驻留在内存中，则为 Any，否则PASSIVE_LEVEL