RtlStringCbVPrintfExW 函数 (ntstrsafe.h)

RtlStringCbVPrintfExWRtlStringCbVPrintfExA 函数创建字节计数的文本字符串,其格式基于提供的格式设置信息。

语法

NTSTRSAFEDDI RtlStringCbVPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR pszFormat,
  [in]            va_list          argList
);

参数

[out, optional] pszDest

指向调用方提供的缓冲区的指针,该缓冲区接收格式化的以 null 结尾的字符串。 函数从 pszFormat 提供的格式设置字符串和 argList 提供的参数创建此字符串。 pszDest 指针可以为 NULL,但前提是在 dwFlags 中设置了STRSAFE_IGNORE_NULLS。

[in] cbDest

目标缓冲区的大小(以字节为单位)。 缓冲区必须足够大,才能包含格式化字符串加上终止 null 字符。

对于 Unicode 字符串,最大字节数为 NTSTRSAFE_MAX_CCH * sizeof (WCHAR) 。

对于 ANSI 字符串,最大字节数为 NTSTRSAFE_MAX_CCH * size of (char) 。

如果 pszDestNULL则 cbDest 必须为零。

[out, optional] ppszDestEnd

如果调用方提供非 NULL 地址指针,则在操作完成后,函数会使用指向目标缓冲区生成的 null 字符串终止符的指针加载该地址。

[out, optional] pcbRemaining

如果调用方提供非 NULL 地址指针,则该函数将使用 pszDest 指向的缓冲区中未使用的字节数(包括用于终止 null 字符的字节数)加载地址。

[in] dwFlags

一个或多个标志以及填充字节(可选)。 这些标志的定义如下:

含义
STRSAFE_FILL_BEHIND_NULL
如果设置且函数成功,则 dwFlags 的低字节用于填充目标缓冲区中终止 null 字符后面的部分。
STRSAFE_IGNORE_NULLS
如果已设置, 则 pszDest pszSrc 或两者都可以为 NULLNULLpszSrc 指针被视为空字符串 (TEXT (“”) ) (可以复制)。 NULLpszDest 指针无法接收非空字符串。
STRSAFE_FILL_ON_FAILURE
如果设置并且函数失败,则 dwFlags 的低字节用于填充整个目标缓冲区,并且缓冲区以 null 结尾。 此操作将覆盖所有预先存在的缓冲区内容。
STRSAFE_NULL_ON_FAILURE
如果设置且函数失败,目标缓冲区将设置为空字符串 (TEXT (“”) ) 。 此操作将覆盖所有预先存在的缓冲区内容。
STRSAFE_NO_TRUNCATION
如果设置了 并且函数返回STATUS_BUFFER_OVERFLOW,则不会修改目标缓冲区的内容。

[in, optional] pszFormat

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

[in] argList

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

返回值

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

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

在以下情况下,函数返回STATUS_INVALID_PARAMETER值:

  • 指定的标志无效。
  • cbDest 中的值大于最大缓冲区大小。
  • 目标缓冲区已满。
  • 不存在 STRSAFE_IGNORE_NULLS标志的 NULL 指针。
  • 目标缓冲区指针为 NULL,但缓冲区大小不为零。
  • 目标缓冲区指针为 NULL,或者其长度为零,但存在非零长度源字符串。

注解

应使用 RtlStringCbVPrintfExWRtlStringCbVPrintfExA,而不是以下函数:

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
所有这些函数都接受格式字符串以及 va_list类型参数列表中的一组参数,并返回格式化字符串。 目标缓冲区的大小(以字节为单位)提供给 RtlStringCbVPrintfExWRtlStringCbVPrintfExA ,以确保它们不会写入缓冲区末尾。

RtlStringCbVPrintfExWRtlStringCbVPrintfExA 通过返回指向目标字符串末尾的指针以及该字符串中剩余的未使用的字节数,为 RtlStringCbVPrintf 的功能添加。 标志可以传递给 函数以用于其他控制。

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

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

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

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

除非设置了STRSAFE_IGNORE_NULLS标志,否则 pszFormatpszDest 都不能为 NULL ,在这种情况下,两者都可以为 NULL。 如果 pszDestNULL则 pszFormat 必须为 NULL 或指向空字符串。

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

要求

   
最低受支持的客户端 在 Windows 的 Service Pack 1 (SP1) 及更高版本的 Windows 中可用。
目标平台 桌面
标头 ntstrsafe.h (包括 Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

另请参阅

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchVPrintfEx