RtlStringCchVPrintfW 函数 (ntstrsafe.h)

  • 项目

RtlStringCchVPrintfW 和 RtlStringCchVPrintfA 函数创建字符计数文本字符串，其格式基于提供的格式设置信息。

语法

NTSTRSAFEDDI RtlStringCchVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

参数

[out] pszDest

指向调用方提供的缓冲区的指针，该缓冲区接收格式化的以 null 结尾的字符串。 函数从 pszFormat 提供的格式设置字符串和 argList 提供的参数创建此字符串。

[in] cchDest

目标缓冲区的大小（以字符为单位）。 缓冲区必须足够大，才能包含格式化字符串加上终止 null 字符。 允许的最大字符数为NTSTRSAFE_MAX_CCH。

[in] pszFormat

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

[in] argList

va_list类型的参数列表。 参数列表中包含的参数将使用 pszFormat 提供的格式字符串进行解释。

返回值

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

返回代码 说明
STATUS_SUCCESS
 此 成功 状态表示源数据存在，输出字符串是在未截断的情况下创建的，并且生成的目标缓冲区以 null 结尾。
STATUS_BUFFER_OVERFLOW
 此 警告 状态表示由于目标缓冲区中的空间不足，操作未完成。 目标缓冲区包含已创建字符串的截断版本。
STATUS_INVALID_PARAMETER
 此错误状态表示函数收到了无效的输入参数。 有关详细信息，请参阅以下段落。

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

  • cchDest 中的值大于最大缓冲区大小。
  • 目标缓冲区已满。
  • 存在 NULL 指针。
  • 目标缓冲区长度为零，但存在非零长度源字符串。

注解

应使用 RtlStringCchVPrintfW 和 RtlStringCchVPrintfA，而不是以下函数：

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
所有这些函数都接受格式字符串及其参数（作为 va_list类型的参数列表提供），并返回格式化字符串。 RtlStringCchVPrintfW 和 RtlStringCchVPrintfA 接收目标缓冲区的大小（以字符为单位），以确保函数不会写入缓冲区末尾。

有关va_list类型参数列表的详细信息，请参阅Microsoft Windows SDK文档。

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

字符串数据类型 字符串文本 函数
WCHAR L“string” RtlStringCchVPrintfW
char “字符串” RtlStringCchVPrintfA
 

如果 pszDest 和 pszFormat 指向重叠字符串，或者任何参数字符串重叠，则函数的行为未定义。

pszFormat 和 pszDest 都不能为 NULL。 如果需要处理 NULL 字符串指针值，请使用 RtlStringCchVPrintfEx。

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

要求

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

另请参阅

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx