命名空间
变体
操作

vwprintf、vfwprintf、vswprintf、vwprintf_s、vfwprintf_s、vswprintf_s、vsnwprintf_s

来自 cppreference.com
< c‎ | io
 
C
 
文件输入/输出
类型和对象
函数
文件访问
直接输入/输出
非格式化输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)
格式化输入
(C99)(C99)(C99)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)     
格式化输出
(C99)(C11)(C11)(C11)(C11)
vwprintfvfwprintfvswprintfvwprintf_svfwprintf_svswprintf_svsnwprintf_s
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
文件定位
错误处理
文件操作
(C11)
(C11)
 
定义在头文件 <wchar.h> 中
(1)
int vwprintf( const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vwprintf( const wchar_t* restrict format, va_list vlist );
 (自 C99 起)
(2)
int vfwprintf( FILE* stream, const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vfwprintf( FILE* restrict stream,
               const wchar_t* restrict format, va_list vlist );
 (自 C99 起)
(3)
int vswprintf( wchar_t* buffer, size_t bufsz,
               const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vswprintf( wchar_t* restrict buffer, size_t bufsz,
               const wchar_t* restrict format, va_list vlist );
 (自 C99 起)
int vwprintf_s( const wchar_t* restrict format, va_list vlist);
 (4) (自 C11 起)
int vfwprintf_s( FILE* restrict stream,
                 const wchar_t* restrict format, va_list vlist);
 (5) (自 C11 起)
int vswprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                 const wchar_t* restrict format, va_list vlist);
 (6) (自 C11 起)
int vsnwprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                  const wchar_t* restrict format, va_list vlist);
 (7) (自 C11 起)

从 vlist 定义的位置加载数据，将它们转换为宽字符串等效项，并将结果写入各种接收器。

1) 将结果写入 stdout.
2) 将结果写入文件流 stream.
3) 将结果写入宽字符串 buffer. 最多写入 bufsz - 1 个宽字符，然后是空宽字符。生成的宽字符字符串将以空宽字符结尾，除非 bufsz 为零。
4-6) 与 (1-3) 相同，但以下错误会在运行时被检测到并调用当前安装的 约束处理程序 函数
  • 转换说明符 %n 存在于 format 中
  • 任何与 %s 对应的参数都是空指针
  • format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX / sizeof(wchar_t)
  • 在任何字符串和字符转换说明符中发生编码错误
  • (仅针对 vswprintf_s)，要存储在 buffer 中的字符串（包括尾随的空宽字符）将超过 bufsz.
7) 与 (6) 相同，但它会将结果截断以适合 buffer 指向的数组。
与所有边界检查函数一样，vwprintf_s、vfwprintf_s、vswprintf_s 和 vsnwprintf_s 仅在实现定义了 __STDC_LIB_EXT1__ 并且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时才保证可用。

内容

[编辑] 参数

stream - 要写入的输出宽流
buffer - 指向要写入的宽字符串的指针
bufsz - 要写入的宽字符的最大数量
format - 指向指定如何解释数据的空终止宽字符串的指针
vlist - 可变参数列表，包含要打印的数据。


format 字符串由普通宽字符（除了 %）组成，这些字符将不变地复制到输出流中，以及转换说明符。每个转换说明符具有以下格式

  • 介绍性 % 字符。
  • (可选) 一个或多个标志，这些标志修改转换的行为
  • -: 转换结果在字段中左对齐（默认情况下为右对齐）。
  • +: 有符号转换的符号始终置于转换结果之前（默认情况下，结果仅在为负时才以减号开头）。
  • 空格: 如果有符号转换的结果不以符号字符开头，或为空，则将空格置于结果之前。如果存在 + 标志，则忽略它。
  • #: 执行转换的替代形式。有关确切效果，请参阅下表，否则行为未定义。
  • 0: 对于整数和浮点数转换，使用前导零填充字段，而不是使用空格字符。对于整数，如果显式指定精度，则忽略它。对于使用此标志的其他转换，结果将导致未定义的行为。如果存在 - 标志，则忽略它。
  • (可选) 整数值或 `*`，用于指定最小字段宽度。如果需要，结果将在右对齐时用空格（默认）在左侧填充，在左对齐时用空格在右侧填充。如果使用 `*`，则宽度由类型为 int 的附加参数指定，该参数出现在要转换的参数之前，以及在提供精度的情况下提供精度的参数之前。如果参数的值为负数，则会导致 `-` 标志指定和正字段宽度（注意：这是最小宽度：值永远不会被截断）。
  • (可选) `.` 后跟整数或 `*`，或者两者都不存在，用于指定转换的精度。如果使用 `*`，则精度由类型为 int 的附加参数指定，该参数出现在要转换的参数之前，但在提供最小字段宽度的情况下提供最小字段宽度的参数之后。如果此参数的值为负数，则会被忽略。如果既没有使用数字也没有使用 `*`，则精度被视为零。有关精度的确切影响，请参见下表。
  • (可选) 长度修饰符，用于指定参数的大小（与转换格式说明符结合使用，它指定了对应参数的类型）。
  • 转换格式说明符。

以下格式说明符可用

转换
说明符		 解释 预期
参数类型
长度
修饰符
→ 		hh

(C99)

h (无) l ll

(C99)

j

(C99)

z

(C99)

t

(C99)

L
% 写入文字 `%`。完整的转换规范必须为 `%%`。 N/A N/A N/A N/A N/A N/A N/A N/A N/A
c
写入单个字符。

该参数首先被转换为 wchar_t，就像通过调用 btowc 一样。如果使用l 修饰符，则 `wint_t` 参数首先被转换为 wchar_t。

 N/A N/A
int
wint_t
 N/A N/A N/A N/A N/A
s
写入字符字符串

该参数必须是指向包含多字节字符序列的字符数组的初始元素的指针，该序列从初始移位状态开始，就像通过调用 mbrtowc（使用零初始化的转换状态）一样转换为宽字符数组。精度指定要写入的最大宽字符数。如果未指定精度，则写入所有宽字符，直到但不包括第一个空终止符。如果使用l 说明符，则该参数必须是指向包含 wchar_t 的数组的初始元素的指针。

 N/A N/A
char*
wchar_t*
 N/A N/A N/A N/A N/A
d
i
将有符号整数转换为十进制表示[-]dddd。

精度指定要显示的最小位数。默认精度为 1。

如果转换后的值和精度都为 ​0​，则转换结果为没有字符。
signed char
short
int
long
long long
signed size_t
N/A
o
将无符号整数转换为八进制表示oooo。

精度指定要显示的最小位数。默认精度为 1。如果转换后的值和精度都为 ​0​，则转换结果为没有字符。在备用实现中，如果需要，精度会增加，以写入一个前导零。在这种情况下，如果转换后的值和精度都为 ​0​，则会写入单个 ​0​。
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t 的无符号版本
 N/A
x
X
将无符号整数转换为十六进制表示hhhh。

对于 `x` 转换字母，使用 `abcdef`。
对于 `X` 转换字母，使用 `ABCDEF`。
精度指定要显示的最小位数。默认精度为 1。如果转换后的值和精度都为 ​0​，则转换结果为没有字符。在备用实现中，如果转换后的值不为零，则会将 `0x` 或 `0X` 添加到结果之前。

 N/A
u
将无符号整数转换为十进制表示dddd。

精度指定要显示的最小位数。默认精度为 1。如果转换后的值和精度都为 ​0​，则转换结果为没有字符。

 N/A
f
F
将浮点数转换为以[-]ddd.ddd 形式的十进制表示法。

精度指定在小数点字符之后出现的精确位数。默认精度为 6。在备用实现中，即使没有数字跟随，也会写入小数点字符。有关无穷大和非数字的转换样式，请参见注释。

 N/A N/A
double
double(C99)
 N/A N/A N/A N/A
long double
e
E
将浮点数转换为十进制指数表示法。

对于 `e` 转换样式，使用[-]d.ddde±dd。
对于 `E` 转换样式，使用[-]d.dddE±dd。
指数至少包含两位数字，只有在必要时才会使用更多位数字。如果值为 ​0​，则指数也为 ​0​。精度指定在小数点字符之后出现的精确位数。默认精度为 6。在备用实现中，即使没有数字跟随，也会写入小数点字符。有关无穷大和非数字的转换样式，请参见注释。

 N/A N/A N/A N/A N/A N/A
a
A

(C99)

将浮点数转换为十六进制指数表示法。

对于 `a` 转换样式，使用[-]0xh.hhhp±d。
对于 `A` 转换样式，使用[-]0Xh.hhhP±d。
如果参数是规范化的浮点数，则第一个十六进制数字不为 `0`。如果值为 ​0​，则指数也为 ​0​。精度指定在十六进制点字符之后出现的精确位数。默认精度足以精确地表示该值。在备用实现中，即使没有数字跟随，也会写入小数点字符。有关无穷大和非数字的转换样式，请参见注释。

 N/A N/A N/A N/A N/A N/A
g
G
将浮点数转换为十进制或十进制指数表示法，具体取决于值和精度。

对于 `g` 转换样式，将执行使用样式 `e` 或 `f` 的转换。
对于 `G` 转换样式，将执行使用样式 `E` 或 `F` 的转换。
如果精度不为零，则设 `P` 等于精度，如果未指定精度，则为 6，如果精度为 ​0​，则为 1。然后，如果使用样式 `E` 的转换将具有指数 `X`

  • 如果P > X ≥ −4，则转换使用样式 `f` 或 `F`，精度为P − 1 − X。
  • 否则，转换使用样式 `e` 或 `E`，精度为P − 1。

除非请求备用表示，否则会删除尾随零，如果剩下的部分没有小数部分，也会删除小数点字符。有关无穷大和非数字的转换样式，请参见注释。

 N/A N/A N/A N/A N/A N/A
n
返回到目前为止此对函数的调用写入的字符数。

结果写入到该参数指向的值。该规范可能不包含任何标志、字段宽度或精度。
signed char*
short*
int*
long*
long long*
signed size_t*
N/A
p 写入定义指针的实现定义字符序列。 N/A N/A void* N/A N/A N/A N/A N/A N/A

浮点转换函数将无穷大转换为 `inf` 或 `infinity`。使用哪一个是实现定义的。

非数字转换为 `nan` 或 `nan(char_sequence)`。使用哪一个是实现定义的。

转换 `F`、`E`、`G`、`A` 输出 `INF`、`INFINITY`、`NAN`。

即使 `%c` 需要 `int` 参数，但传递 `char` 也是安全的，因为在调用可变参数函数时会进行整数提升。

固定宽度字符类型（int8_t 等）的正确转换规范在头文件 <inttypes.h> 中定义（尽管 PRIdMAX、PRIuMAX 等与 `%jd`、`%ju` 等同义）。

内存写入转换说明符 %n 是安全漏洞的常见目标，其中格式字符串依赖于用户输入，并且不受边界检查的 `printf_s` 函数族支持。

每个转换说明符的操作之后都有一个序列点；这允许将多个 %n 结果存储在同一个变量中，或者作为极端情况，在同一个调用中打印由早期 %n 修改的字符串。

如果转换规范无效，则行为未定义。

[编辑] 返回值

1,4) 如果成功则返回写入的宽字符数量，如果发生错误则返回负值。
3) 如果成功则返回写入的宽字符数量，如果发生错误则返回负值。如果由于 bufsz 限制导致生成的字符串被截断，函数将返回写入的字符总数（不包括终止的空宽字符），即使没有施加限制。
2,5) 传输到输出流的宽字符数量，如果发生输出错误、运行时约束违反错误或编码错误，则返回负值。
6) 写入 buffer 的宽字符数量，不包括空宽字符（只要 buffer 不是空指针，并且 bufsz 不为零且不大于 RSIZE_MAX/sizeof(wchar_t)，就会始终写入），或者在运行时约束违反时返回零，在编码错误时返回负值。
7) 不包括终止的空字符（只要 buffer 不是空指针，并且 bufsz 不为零且不大于 RSIZE_MAX/sizeof(wchar_t)，就会始终写入）的宽字符数量，如果忽略 bufsz，这些字符将被写入 buffer，或者在运行时约束违反或编码错误时返回负值。

[编辑] 注意

所有这些函数都至少调用一次 va_arg，返回后 arg 的值是不确定的。这些函数不会调用 va_end，必须由调用者完成。

虽然窄字符串提供 vsnprintf，这使得确定所需的输出缓冲区大小成为可能，但对于宽字符串没有等效的函数（直到 C11 的 vsnwprintf_s），为了确定缓冲区大小，程序可能需要调用 vswprintf，检查结果值，并重新分配更大的缓冲区，直到成功为止。

与 vswprintf_s 不同，vsnwprintf_s 会将结果截断以适合 buffer 指向的数组，即使大多数边界检查函数将截断视为错误。

[编辑] 示例

运行此代码
#include <locale.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <time.h>
#include <wchar.h>
 
void debug_wlog(const wchar_t* fmt, ...)
{
    struct timespec ts;
    timespec_get(&ts, TIME_UTC);
    char time_buf[100];
    size_t rc = strftime(time_buf, sizeof time_buf, "%D %T", gmtime(&ts.tv_sec));
    snprintf(time_buf + rc, sizeof time_buf - rc, ".%06ld UTC", ts.tv_nsec / 1000);
 
    va_list args;
    va_start(args, fmt);
    wchar_t buf[1024];
    int rc2 = vswprintf(buf, sizeof buf / sizeof *buf, fmt, args);
    va_end(args);
 
    if(rc2 > 0)
       wprintf(L"%s [debug]: %ls\n", time_buf, buf);
    else
       wprintf(L"%s [debug]: (string too long)\n", time_buf);
}
 
int main(void)
{
    setlocale(LC_ALL, "");
    debug_wlog(L"Logging, %d, %d, %d", 1, 2, 3);
}

可能的输出

02/20/15 22:12:38.476575 UTC [debug]: Logging, 1, 2, 3

[编辑] 参考资料

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.29.2.5 vfwprintf 函数 (p: 待定)
  • 7.29.2.7 vswprintf 函数 (p: 待定)
  • 7.29.2.9 vwprintf 函数 (p: 待定)
  • K.3.9.1.6 vfwprintf_s 函数 (p: 待定)
  • K.3.9.1.8 vsnwprintf_s 函数 (p: 待定)
  • K.3.9.1.9 vswprintf_s 函数 (p: 待定)
  • K.3.9.1.11 vwprintf_s 函数 (p: 待定)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.29.2.5 vfwprintf 函数 (p: 待定)
  • 7.29.2.7 vswprintf 函数 (p: 待定)
  • 7.29.2.9 vwprintf 函数 (p: 待定)
  • K.3.9.1.6 vfwprintf_s 函数 (p: 待定)
  • K.3.9.1.8 vsnwprintf_s 函数 (p: 待定)
  • K.3.9.1.9 vswprintf_s 函数 (p: 待定)
  • K.3.9.1.11 vwprintf_s 函数 (p: 待定)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.29.2.5 vfwprintf 函数 (p: 417-418)
  • 7.29.2.7 vswprintf 函数 (p: 419)
  • 7.29.2.9 vwprintf 函数 (p: 420)
  • K.3.9.1.6 vfwprintf_s 函数 (p: 632)
  • K.3.9.1.8 vsnwprintf_s 函数 (p: 633-634)
  • K.3.9.1.9 vswprintf_s 函数 (p: 634-635)
  • K.3.9.1.11 vwprintf_s 函数 (p: 636)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.24.2.5 vfwprintf 函数 (p: 363)
  • 7.24.2.7 vswprintf 函数 (p: 364)
  • 7.24.2.9 vwprintf 函数 (p: 365)

[编辑] 另请参见

(C99)(C11)(C11)(C11)(C11)
 将格式化的输出打印到 stdout、文件流或缓冲区
使用可变参数列表
(函数) [编辑]
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
 将格式化的宽字符输出打印到 stdout、文件流或缓冲区
(函数) [编辑]
C++ 文档 for vwprintf, vfwprintf, vswprintf
Retrieved from "https://cppreference.cn/mwiki/index.php?title=c/io/vfwprintf&oldid=172069"