Namespaces
Variants

vwprintf, vfwprintf, vswprintf, vwprintf_s, vfwprintf_s, vswprintf_s, vsnwprintf_s

来自cppreference.net
< c | io
 
 
文件输入/输出
类型和对象
        
函数
文件访问
(C95)
无格式输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)

格式化输入
 
定义于头文件 <wchar.h>
int vwprintf( const wchar_t* format, va_list vlist );
(1) (C95 起)
(C99 前)
int vwprintf( const wchar_t* restrict format, va_list vlist );
(C99 起)
int vfwprintf( FILE* stream, const wchar_t* format, va_list vlist );
(2) (C95 起)
(C99 前)
int vfwprintf( FILE* restrict stream,
               const wchar_t* restrict format, va_list vlist );
(C99 起)
int vswprintf( wchar_t* buffer, size_t bufsz,
               const wchar_t* format, va_list vlist );
(3) (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__ 并且用户在包含 __STDC_WANT_LIB_EXT1__stdio.h1 之前将 < 定义为整数常量 > 时才保证可用。

参数

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


format字符串由普通宽字符(除了 %)组成,这些字符原样复制到输出流,以及转换说明。每个转换说明具有以下格式:

  • 引入的 % 字符。
  • (可选) 一个或多个修改转换行为的标志:
  • -:转换结果在字段内左对齐(默认是右对齐)。
  • +:有符号转换的结果前始终添加符号(默认仅在负数前加负号)。
  • 空格:如果有符号转换的结果不以符号字符开头或为空,则在结果前添加空格。如果存在 + 标志则忽略。
  • #:执行转换的 替代形式。具体效果见下表,否则行为未定义。
  • 0:对于整数和浮点数转换,使用前导零填充字段,而不是 空格字符。对于整数,如果显式指定了精度则忽略。对于其他使用此标志的转换会导致未定义行为。如果存在 - 标志则忽略。
  • (可选) 整数值或 *,指定最小字段宽度。如果必要,结果用 空格字符填充(默认),右对齐时在左侧填充,左对齐时在右侧填充。当使用 * 时,宽度由类型为 int 的额外实参指定,该实参出现在要转换的实参之前,并在指定精度时出现在提供精度的实参之前。如果该实参的值为负,则相当于指定了 - 标志和正字段宽度(注意:这是最小宽度:值永远不会被截断)。
  • (可选) . 后跟整数或 *,或者都不跟,指定转换的 精度。当使用 * 时,精度 由类型为 int 的额外实参指定,该实参出现在要转换的实参之前,但在提供最小字段宽度的实参之后(如果有)。如果该实参的值为负,则忽略。如果既没有数字也没有 *,则精度视为零。有关 精度 的具体效果见下表。
  • (可选) 长度修饰符,指定实参的大小(与转换格式说明符一起,指定相应实参的类型)。
  • 转换格式说明符。

以下格式说明符可用:

转换
说明符
解释 预期
实参类型
长度修饰符 → hh h 无 l ll j z t L
仅 C99 起可用 → 是 是 是 是 是
% 写入字面量 %。完整的转换说明必须是 %%。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

写入一个单个字符。

  • 实参首先通过调用 wchar_tbtowc 转换为 (如同)。
  • 如果使用 l 修饰符,则 wint_t 实参首先转换为 wchar_t。
不适用 不适用
int
wint_t
不适用 不适用 不适用 不适用 不适用
s

写入一个字符串。

  • 实参必须是指向字符数组首元素的指针,该数组包含从初始迁移状态开始的多字节字符序列,通过调用 mbrtowc(使用零初始化的转换状态)转换为宽字符数组。
  • 精度指定要写入的最大宽字符数。如果未指定精度,则写入直到第一个空终止符(不包括)的所有宽字符。
  • 如果使用 l 说明符,则实参必须是指向 wchar_t 数组首元素的指针。
不适用 不适用
char*
wchar_t*
不适用 不适用 不适用 不适用 不适用
d
i

将有符号整数转换为十进制表示 [-]dddd。

  • 精度指定要出现的最小位数。默认精度是 1。
  • 如果转换后的值和精度都为 0,则转换不产生字符。
  • 对于 z 修饰符,预期的实参类型是有符号版本的 size_t。
signed char
short
int
long
long long
intmax_t
※
ptrdiff_t
不适用
b
B (可选)

(C23)

将无符号整数转换为二进制表示 bbbb。

  • 精度指定要出现的最小位数。默认精度是 1。
  • 如果转换后的值和精度都为 0,则转换不产生字符。
  • 在替代实现 0b中,如果转换后的值非零,则结果前添加 0B。
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
uintmax_t
size_t
无符号版本的 ptrdiff_t
不适用
o

将无符号整数转换为八进制表示 oooo。

  • 精度指定要出现的最小位数。默认精度是 1。
  • 如果转换后的值和精度都为 0,则转换不产生字符。
  • 在替代实现中,必要时增加精度,以写入前导零。在这种情况下,如果转换后的值和精度都为 0,则写入单个 0。
不适用
x
X

将无符号整数转换为十六进制表示 hhhh。

  • 对于 x 转换,使用字母 abcdef。
  • 对于 X 转换,使用字母 ABCDEF。
  • 精度指定要出现的最小位数。默认精度是 1。
  • 如果转换后的值和精度都为 0,则转换不产生字符。
  • 在替代实现 0x中,如果转换后的值非零,则结果前添加 0X。
不适用
u

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

  • 精度指定要出现的最小位数。
  • 默认精度是 1。
  • 如果转换后的值和精度都为 0,则转换不产生字符。
不适用
f
F (C99)

将浮点数转换为十进制记数法,格式为 [-]ddd.ddd。

  • 精度指定小数点后要出现的精确位数。
  • 默认精度是 6。
  • 在替代实现中,即使后面没有数字也会写入小数点。
  • 对于无穷大和非数转换样式,见 注解。
不适用 不适用
double
double (C99)
不适用 不适用 不适用 不适用
long double
e
E

将浮点数转换为十进制指数记数法。

  • 对于 e 转换样式,使用 [-]d.ddd e±dd。
  • 对于 E 转换样式,使用 [-]d.ddd E±dd。
  • 指数至少包含两位数字,仅在必要时使用更多数字。
  • 如果值为 0,则指数也为 0。
  • 精度指定小数点后要出现的精确位数。
  • 默认精度是 6。
  • 在替代实现中,即使后面没有数字也会写入小数点。
  • 对于无穷大和非数转换样式,见 注解。
不适用 不适用 不适用 不适用 不适用 不适用
a
A

(C99)

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

  • 对于 a 转换样式,使用 [-] 0xh.hhh p±d。
  • 对于 A 转换样式,使用 [-] 0Xh.hhh P±d。
  • 如果实参是规范化的浮点值,则第一个十六进制数字不是 0。
  • 如果值为 0,则指数也为 0。
  • 精度指定十六进制小数点后要出现的精确位数。
  • 默认精度足够精确表示该值。
  • 在替代实现中,即使后面没有数字也会写入小数点。
  • 对于无穷大和非数转换样式,见 注解。
不适用 不适用 不适用 不适用 不适用 不适用
g
G

根据值和 精度将浮点数转换为十进制或十进制指数记数法。

  • 对于 g 转换样式,将使用样式 e 或 f 进行转换。
  • 对于 G 转换样式,将使用样式 E 或 f(C99 前)F(C99 起) 进行转换。
  • 设 P 等于非零精度,如果未指定精度则为 6,如果精度为 1 则为 0。然后,如果使用样式 E 的转换的指数为 X:
    • 如果 P > X ≥ −4,使用样式 f 或 F(C99 起) 进行转换,精度为 P − 1 − X。
    • 否则,使用样式 e 或 E 进行转换,精度为 P − 1。
  • 除非要求 替代表示,否则移除尾部零,如果没有小数部分则也移除小数点。
  • 对于无穷大和非数转换样式,见 注解。
不适用 不适用 不适用 不适用 不适用 不适用
n

返回此次函数调用到目前为止写入的字符数。

  • 结果写入到实参指向的值。说明中不能包含任何
  • 标志、字段宽度或 精度。对于
  • 修饰符,预期实参类型是 z,其中 S* 是有符号版本的 S。size_tintmax_t
signed char*
short*
int*
long*
long long*
※ *
ptrdiff_t
 不适用* 
写入实现定义的定义
p

指针的字符序列。 不适用

不适用 不适用
void*
不适用 不适用 不适用 不适用 不适用 不适用
注解

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

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

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

用于打印 char、unsigned char、signed char、short 和 unsigned short 的转换说明符期望 默认参数提升后的提升类型,但在打印前其值将转换为 char、unsigned char、signed char、short 和 unsigned short。由于调用可变参数函数时会发生提升,传递这些类型的值是安全的。

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

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

每个转换说明符的动作之后存在一个序列点;这允许多个 %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),则始终写入空字符)的宽字符数,该数字本应写入 buffer(如果忽略 bufsz),如果发生运行时约束违规或编码错误,则返回负值。

注解

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

虽然窄字符串提供了 vsnprintf,使得可以确定所需的输出缓冲区大小,但没有宽字符串的等价函数(直到 C11 的 vsnwprintf_s)。为了确定缓冲区大小,程序可能需要调用 vswprintf,检查结果值,并重新分配更大的缓冲区,重复尝试直到成功。

vsnwprintf_s与 vswprintf_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 The vfwprintf function (p: TBD)
  • 7.29.2.7 The vswprintf function (p: TBD)
  • 7.29.2.9 The vwprintf function (p: TBD)
  • K.3.9.1.6 The vfwprintf_s function (p: TBD)
  • K.3.9.1.8 The vsnwprintf_s function (p: TBD)
  • K.3.9.1.9 The vswprintf_s function (p: TBD)
  • K.3.9.1.11 The vwprintf_s function (p: TBD)
  • C17 标准(ISO/IEC 9899:2018):
  • 7.29.2.5 The vfwprintf function (p: TBD)
  • 7.29.2.7 The vswprintf function (p: TBD)
  • 7.29.2.9 The vwprintf function (p: TBD)
  • K.3.9.1.6 The vfwprintf_s function (p: TBD)
  • K.3.9.1.8 The vsnwprintf_s function (p: TBD)
  • K.3.9.1.9 The vswprintf_s function (p: TBD)
  • K.3.9.1.11 The vwprintf_s function (p: TBD)
  • C11 标准(ISO/IEC 9899:2011):
  • 7.29.2.5 The vfwprintf function (p: 417-418)
  • 7.29.2.7 The vswprintf function (p: 419)
  • 7.29.2.9 The vwprintf function (p: 420)
  • K.3.9.1.6 The vfwprintf_s function (p: 632)
  • K.3.9.1.8 The vsnwprintf_s function (p: 633-634)
  • K.3.9.1.9 The vswprintf_s function (p: 634-635)
  • K.3.9.1.11 The vwprintf_s function (p: 636)
  • C99 标准(ISO/IEC 9899:1999):
  • 7.24.2.5 The vfwprintf function (p: 363)
  • 7.24.2.7 The vswprintf function (p: 364)

7.24.2.9 The vwprintf function (p: 365)

(C11)使用可变参数列表将格式化输出打印到 stdout
、文件流或缓冲区
(函数)
将格式化宽字符输出打印到 stdout、文件流或缓冲区
(函数)
C++ 文档 关于 vwprintf、vfwprintf、vswprintf