RtlUnicodeStringVPrintf 函数 (ntstrsafe.h)

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

语法

NTSTRSAFEDDI RtlUnicodeStringVPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

参数

[out] DestinationString

指向接收格式化字符串的 UNICODE_STRING 结构的指针。 RtlUnicodeStringVPrintfpszFormat 指定的格式字符串和函数的参数列表创建此字符串。 字符串中的最大字符数NTSTRSAFE_UNICODE_STRING_MAX_CCH。

[in] pszFormat

指向以 null 结尾的文本字符串的指针,该字符串包含 printf样式格式设置指令。

[in] argList

va_list类型化参数列表。 此参数列表中的参数将使用 pszFormat 指定的格式字符串进行解释。

返回值

RtlUnicodeStringVPrintf 返回以下 NTSTATUS 值之一。

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

RtlUnicodeStringVPrintf 在发生以下任一情况时返回STATUS_INVALID_PARAMETER值:

  • DestinationString 指向的 UNICODE_STRING 结构的内容无效。
  • 目标缓冲区已满。
  • 存在 NULL 指针。
  • 目标缓冲区的长度为零,但存在非零长度源字符串。
有关如何测试 NTSTATUS 值的信息,请参阅 使用 NTSTATUS 值

言论

RtlUnicodeStringVPrintf 函数使用目标缓冲区的大小来确保字符串格式设置作不会写入缓冲区末尾。 该函数不会终止具有 null 字符的结果字符串。

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

pszFormatDestinationString 指针不能 NULL。 如果需要处理 NULL 指针值,请使用 RtlUnicodeStringVPrintfEx 函数。

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

要求

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

另请参阅

RtlUnicodeStringPrintf

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintfEx

UNICODE_STRING