vwprintf, vfwprintf, vswprintf, vwprintf_s, vfwprintf_s, vswprintf_s

来自cppreference.com
< c‎ | io
 
 
文件输入/输出
函数
文件访问
直接输入/输出
无格式输入/输出
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
格式输入
格式输出
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的参数是空指针
  • formatbuffer是空指针
  • bufsz为零或大于RSIZE_MAX
  • 在任何一个字符串及字符转换指定符中出现编码错误
  • (仅对于vswprintf_s)要存储于buffer(含尾随宽空字符)的宽字符串长度将超出bufsz
同所有边界检查函数, vwprintf_s, vfwprintf_s, vswprintf_s, vsnwprintf_s 仅若实现定义了 __STDC_LIB_EXT1__ ,且用户在包含 <wchar.h> 前定义 __STDC_WANT_LIB_EXT1__ 为整数常量 1 才保证可用。

目录

[编辑] 参数

stream - 要写入的输出宽流
buffer - 指向要写入的宽字符串的指针
bufsz - 写入的最大宽字符数(含空终止宽字符)
format - 指向指定数据转译方式的空终止宽字符串的指针。

格式字符串由会被无更改地复制到输出流的普通宽字符(除了 % ),和转换指定构成。每个转换指定拥有下列格式:

  • 引入的 % 字符
  • (可选)一或多个修改转换行为的标签:
  • - :转换结果在域内左校正(默认是右校正的)
  • + :有符号转换的符号始终前置于转换结果(默认结果前置负号仅当它为负)
  • 空格:若有符号转换的结果不以符号开始,或为空,则前置空格于结果。若存在 + 标签则忽略空格
  • # :进行另一种形式的转换。准确的效果见下表,其他情况下行为未定义。
  • 0 :对于整数和浮点数转换,使用前导零代替空格字符填充域。对于整数,若显式指定精度,则忽略此标签。对于其他转换,使用此标签导致未定义行为。若存在 - 标签则忽略 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
有符号 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 ,则转换结果无字符。 在另一种实现中若被转换值为非零则结果有 0x0X 前缀。

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 转换样式将进行带样式 ef 的转换。
G 转换样式将进行带样式 EF 的转换。
P 等于精度,若它非零,若精度未指定则为 6 ,若精度为 0 则等于 1 。然后,若带样式 E 的转换会有指数 X ,则:

  • P > X ≥ −4 ,则转换带 fF 风格,及精度 P − 1 − X
  • 否则,转换带 eE 风格,及精度 P − 1

除非要求另一种表示,否则末尾零会被移除,且若不留下小数部分则小数点亦被移除。 无穷大和非数的转换样式见注意。

N/A N/A N/A N/A N/A N/A
n
返回对函数的此调用迄今为止写入的字符数

结果被写入到参数所指向的值。 该指定不可含有任何标签域宽精度

signed char*
short*
int*
long*
long long*
有符号 size_t*
N/A
p 写定义一个指针的实现定义字符序列。 N/A N/A void* N/A N/A N/A N/A N/A N/A

浮点转换函数转换无穷大到 infinfinity 。使用哪一个是实现定义的。

非数转换成 nannan(char_sequence) 。使用哪一个是实现定义的。

转换 FEGA 替代上面输出 INFINFINITYNAN

尽管 %c 期待 int 参数,传递 char 是安全的,因为在调用变参数函数时发生整数提升。

定宽整数类型( int8_t 等)的正确转换指定定义于头文件 <inttypes.h> (尽管 PRIdMAXPRIuMAX等就是 %jd%ju 等的别名)。

内存写入转换指定符 %n 是安全漏洞的常见目标,这里格式字符串依赖用户输入,而此转换指定符不为边界检查的 printf_s 系列函数所支持。

在每个转换限定符的行动后有一个序列点;这允许存入多次 %n 的结果于同一变量,并在同一调用中打印出先前以 %n 存储的值。

若转换限定非法,则行为未定义。


vlist - 含有要打印数据的变量参数列表

[编辑] 返回值

1,2) 若成功则为写入的宽字符数,若错误发生则为负值。
3) 若成功则为写入的宽字符数,若失败发生则为负值。若生成的字符串因bufsz限制被截断,则函数返回假如未强加限制则本应吸入的字符数(不含空终止宽字符)。
4,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_svsnwprintf_s将截断结果以适应buffer所指向的数组,尽管这种截断被多数边界检查函数当做错误。

[编辑] 示例

#include <stdio.h>
#include <time.h>
#include <locale.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[1000];
    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

[编辑] 参考

  • C11 standard (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.9 The vswprintf_s function (p: 634-635)
  • K.3.9.1.11 The vwprintf_s function (p: 636)
  • C99 standard (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)

[编辑] 参阅

打印格式化输出到stdout、文件流或缓冲区
使用可变参数列表
(函数) [编辑]
打印格式化宽字符输出到stdout、文件流或缓冲区
(函数) [编辑]
vwprintf, vfwprintf, vswprintfC++ 文档