命名空间
变体
操作

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

来自 cppreference.cn
< c‎ | io
 
C
 
文件输入/输出
类型和对象
        
函数
文件访问
(C11)
(C11)  
(C95)
非格式化输入/输出
(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)
文件定位
错误处理
文件操作
 
在头文件 <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) 相同，但以下错误会在运行时检测到并调用当前安装的 约束处理函数
  • format 中存在转换说明符 %n
  • 任何对应于 %s 的参数都是空指针
  • format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX / sizeof(wchar_t)
  • 在任何字符串和字符转换说明符中发生编码错误
  • (仅适用于 vswprintf_s)，要存储在 buffer 中的字符串（包括尾随的宽空字符）将超出 bufsz。
7) 与 (6) 相同，但它会截断结果以适应由 buffer 指向的数组。
与所有边界检查函数一样，只有当实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时，才能保证 vwprintf_s、vfwprintf_s、vswprintf_s 和 vsnwprintf_s 可用。

目录

[edit] 参数

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


format 字符串由普通宽字符（除了 %）组成，这些字符按原样复制到输出流中，以及转换规范。每个转换规范具有以下格式

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

以下格式说明符可用：

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

写入单个字符。

  • 参数首先转换为 wchar_t，如同调用 btowc。
  • 如果使用了 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
※
不适用
o

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

  • 精度指定要出现的最小位数。默认精度为 1。
  • 如果转换值和精度都为 ​0​，则转换结果不包含任何字符。
  • 在*替代实现*中，如果需要，精度会增加以写入一个前导零。在这种情况下，如果转换值和精度都为 ​0​，则写入单个 ​0​。
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t 的无符号版本
 不适用
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，如果精度为 ​0​ 则为 1。然后，如果样式 E 的转换指数为 X
    • 如果 P > X ≥ −4，则转换样式为 f 或 F(C99 起)，精度为 P − 1 − X。
    • 否则，转换使用样式 e 或 E，精度为 P − 1。
  • 除非请求替代表示，否则会删除尾随零，如果不再有小数部分，也会删除小数点字符。
  • 关于无穷大和非数字的转换样式，请参见注释。
 不适用 不适用 不适用 不适用 不适用 不适用
n

返回此函数调用目前已写入的字符数。

  • 结果被写入到参数指向的值。
  • 说明符不得包含任何标志、字段宽度或精度。
  • 对于 z 修饰符，预期参数类型是 S*，其中 S 是 size_t 的有符号版本。
signed char*
short*
int*
long*
long long*
※
不适用
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 修改的字符串。

如果转换说明符无效，则行为未定义。

[edit] 返回值

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，如果发生运行时约束违反或编码错误则为负值。

[edit] 注意

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

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

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

[edit] 示例

运行此代码
#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

[edit] 参考

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.29.2.5 vfwprintf 函数 (p: TBD)
  • 7.29.2.7 vswprintf 函数 (p: TBD)
  • 7.29.2.9 vwprintf 函数 (p: TBD)
  • K.3.9.1.6 vfwprintf_s 函数 (p: TBD)
  • K.3.9.1.8 vsnwprintf_s 函数 (p: TBD)
  • K.3.9.1.9 vswprintf_s 函数 (p: TBD)
  • K.3.9.1.11 vwprintf_s 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.29.2.5 vfwprintf 函数 (p: TBD)
  • 7.29.2.7 vswprintf 函数 (p: TBD)
  • 7.29.2.9 vwprintf 函数 (p: TBD)
  • K.3.9.1.6 vfwprintf_s 函数 (p: TBD)
  • K.3.9.1.8 vsnwprintf_s 函数 (p: TBD)
  • K.3.9.1.9 vswprintf_s 函数 (p: TBD)
  • K.3.9.1.11 vwprintf_s 函数 (p: TBD)
  • 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)

[edit] 另请参阅

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