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 的 Service Pack 1 (SP1) 及更高版本的 Windows 中可用。
目标平台 桌面
标头 ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL 如果正在操作的字符串始终驻留在内存中,则为 Any,否则PASSIVE_LEVEL

另请参阅

RtlUnicodeStringPrintf

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintfEx

UNICODE_STRING