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

来自cppreference.com
< 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。至多写入后随空宽字符的 size - 1 个宽字符。产生的宽字符串将以空宽字符终止，除非 bufsz 为零。
4-6) 同 (1-3)，除了在运行时检测下列错误，并调用当前安装的约束处理函数：
  • format 中存在转换指定符 %n
  • 任何一个对应 %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 - 含有待打印数据的可变实参列表

格式字符串由普通宽字符（除了 %）和转换指示构成，前者被不改动地复制到输出流。每个转换指示均拥有下列格式：

  • 引入的 % 字符。
  • (可选) 一或多个修改转换行为的标志：
  • -：转换结果在域内左对齐（默认为右对齐）。
  • +：有符号转换的符号始终前置于转换结果（默认仅当结果为负时前置负号）。
  • 空格：如果有符号转换的结果不以符号开始，或为空，那么前置空格于结果。存在 + 标志时忽略空格。
  • #：进行替用形式 的转换。确切的效果见下表，其他情况下行为未定义。
  • 0：对于整数和浮点数转换，使用前导零代替空格 字符填充字段。对于整数，如果显式指定了精度，那么忽略此标志。对于其他转换，使用此标志导致未定义行为。存在 - 标志时忽略 0。
  • (可选) 整数或 *，指定最小字段宽度。如果有要求，那么结果会以空格 字符（默认情况）填充，在右对齐时于左，左对齐时于右。使用 * 的情况下，以一个额外的 int 类型实参指定宽度。如果实参值是负数，那么它导致指定 - 标志和正的字段宽度。（注意：这是最小宽度：值决不会被截断）。
  • (可选) 后随整数或 * 或两者皆无的 .，指示转换的精度 。在使用 * 的情况下，精度 由额外的 int 类型的实参指定。如果此实参的值是负数，那么它被忽略。如果既不使用数字也不使用 *，那么精度采用零。精度 的确切效果见下表。
  • (可选) 指定实参大小的长度修饰符（其与格式指示符组合，指定对应实参的类型）。
  • 转换格式指示符

下列格式指示符可用：

 转换指示符  解释 期望的实参类型
长度修饰符→ hh h 无 l ll j z t L
仅从 C99 起可用→ 是 是 是 是 是
%

写入字面的 %。完整的转换指示必须是 %%。

不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

写入单个字符。

  • 实参首先如同通过调用 btowc 被转换成 wchar_t。
  • 如果使用 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 存储的值。

如果转换指示非法，那么行为未定义。

返回值

1,4) 若成功则为写入的宽字符数，若出现错误则为负值。
3) 若成功则为写入的宽字符数，若出现失败则为负值。若生成的字符串因 bufsz 限制被截断，则函数返回假如未强加限制则本应写入的字符数（不含空终止宽字符）。
2,5) 传输到输出流的宽字符数，或若出现输出错误、运行时制约违规错误或编码错误则为负值。
6) 写入 buffer 的宽字符数，不计空宽字符（只要 buffer 非空指针且 bufsz 非零且不大于 RSIZE_MAX/sizeof(wchar_t)，就写入它），或在运行时制约违规时为零，或在编码错误时为负值。
7) 假如忽略 bufsz 则本应写入 buffer 的宽字符数，不计空宽字符（只要 buffer 不是空指针且 bufsz 非零且不大于 RSIZE_MAX/sizeof(wchar_t)，就写入它），或若运行时制约违规或编码错误发生则为负值。

注解

所有这些函数调用 va_arg 至少一次，在返回后 vlist 的值不确定。这些函数不调用 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]: (字符串过长)\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 （第 TBD 页）
  • 7.29.2.7 The vswprintf function （第 TBD 页）
  • 7.29.2.9 The vwprintf function （第 TBD 页）
  • K.3.9.1.6 The vfwprintf_s function （第 TBD 页）
  • K.3.9.1.8 The vsnwprintf_s function （第 TBD 页）
  • K.3.9.1.9 The vswprintf_s function （第 TBD 页）
  • K.3.9.1.11 The vwprintf_s function （第 TBD 页）
  • C17 标准（ISO/IEC 9899:2018）：
  • 7.29.2.5 The vfwprintf function （第 TBD 页）
  • 7.29.2.7 The vswprintf function （第 TBD 页）
  • 7.29.2.9 The vwprintf function （第 TBD 页）
  • K.3.9.1.6 The vfwprintf_s function （第 TBD 页）
  • K.3.9.1.8 The vsnwprintf_s function （第 TBD 页）
  • K.3.9.1.9 The vswprintf_s function （第 TBD 页）
  • K.3.9.1.11 The vwprintf_s function （第 TBD 页）
  • C11 标准（ISO/IEC 9899:2011）：
  • 7.29.2.5 The vfwprintf function （第 417-418 页）
  • 7.29.2.7 The vswprintf function （第 419 页）
  • 7.29.2.9 The vwprintf function （第 420 页）
  • K.3.9.1.6 The vfwprintf_s function （第 632 页）
  • K.3.9.1.8 The vsnwprintf_s function （第 633-634 页）
  • K.3.9.1.9 The vswprintf_s function （第 634-635 页）
  • K.3.9.1.11 The vwprintf_s function （第 636 页）
  • C99 标准（ISO/IEC 9899:1999）：
  • 7.24.2.5 The vfwprintf function （第 363 页）
  • 7.24.2.7 The vswprintf function （第 364 页）
  • 7.24.2.9 The vwprintf function （第 365 页）

参阅

(C99)(C11)(C11)(C11)(C11)
 打印格式化输出到 stdout、文件流或缓冲区
使用可变参数列表
(函数)
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
 打印格式化宽字符输出到 stdout、文件流或缓冲区
(函数)
vwprintf, vfwprintf, vswprintf 的 C++ 文档
来自“https://zh.cppreference.com/mwiki/index.php?title=c/io/vfwprintf&oldid=91403”