vprintf, vfprintf, vsprintf, vsnprintf, vprintf_s, vfprintf_s, vsprintf_s, vsnprintf_s

来自cppreference.com
< c‎ | io
 
C
 
文件输入/输出
类型与对象
函数
文件访问
直接输入/输出
无格式输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)
有格式输入
有格式输出
vprintfvfprintfvsprintfvsnprintfvprintf_svfprintf_svsprintf_svsnprintf_s
(C99)(C11)(C11)(C11)(C11)
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
文件寻位
错误处理
文件上的操作
(C11)
(C11)
 
在标头 <stdio.h> 定义
(1)
int vprintf( const char *format, va_list vlist );
 (C99 前)
int vprintf( const char *restrict format, va_list vlist );
 (C99 起)
(2)
int vfprintf( FILE *stream, const char *format, va_list vlist );
 (C99 前)
int vfprintf( FILE *restrict stream, const char *restrict format,
              va_list vlist );
 (C99 起)
(3)
int vsprintf( char *buffer, const char *format, va_list vlist );
 (C99 前)
int vsprintf( char *restrict buffer, const char *restrict format,
              va_list vlist );
 (C99 起)
int vsnprintf( char *restrict buffer, size_t bufsz,
               const char *restrict format, va_list vlist );
 (4) (C99 起)
int vprintf_s( const char *restrict format, va_list arg);
 (5) (C11 起)
int vfprintf_s( FILE *restrict stream, const char *restrict format,
                va_list arg);
 (6) (C11 起)
int vsprintf_s( char *restrict buffer, rsize_t bufsz,
                const char *restrict format, va_list arg);
 (7) (C11 起)
int vsnprintf_s(char *restrict buffer, rsize_t bufsz,
                const char *restrict format, va_list arg);
 (8) (C11 起)

从 vlist 所定义的位置加载数据，将它们转换成字符串等价物，并将结果写入各种池。

1) 写结果到 stdout。
2) 写结果到文件流 stream 。
3) 写结果到字符串 buffer 。
4) 写结果到字符串 buffer 。至多写入 bufsz 个字符。产生的字符串将以空字符终止，除非 bufsz 为零。若 bufsz 为零，则不写入任何内容，且 buffer 可为空指针，然而照样计算并返回返回值（本应写入的字节数，不包含空终止符）。
5-8) 同 (1-4) ，除了在运行时检测下列错误，并调用当前安装的约束处理函数：
  • format 中存在转换说明符 %n
  • 任何一个对应 %s 的参数是空指针
  • format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX
  • 任何一个字符串及字符转换说明符中出现编码错误
  • （仅对于 vsprintf_s ）存储于 buffer 的字符串（包括尾随空字符）长度将超出 bufsz
同所有边界检查函数， vprintf_s, vfprintf_s, vsprintf_s, vsnprintf_s 仅若实现定义了 __STDC_LIB_EXT1__ ，且用户在包含 <stdio.h> 前定义 __STDC_WANT_LIB_EXT1__ 为整数常量 1 才保证可用。

参数

stream - 要写入的输出文件流
buffer - 指向要写入的字符串的指针
bufsz - 至多可以写入 bufsz - 1 个字符，再加上空终止符
format - 指向指定数据转译方式的空终止字符串的指针。

格式字符串由普通多字节字符（除了 % ）和转换指示构成，前者被复制到输出流而无更改。每个转换指示拥有下列格式：

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

下列格式指示符可用：

转换
指示符 		解释 参数类型
长度修饰符 hh

(C99)

h （无） l ll

(C99)

j

(C99)

z

(C99)

t

(C99)

L
% 写字面的 % 。完整转换指示必须是 %% 。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c
写单个字符。

参数首先被转换成 unsigned char 。 若使用 l 修饰符，则参数首先被转换成字符串，如同通过以 wchar_t[2] 参数使用 %ls 。

不适用 不适用
int
wint_t
 不适用 不适用 不适用 不适用 不适用
s
写字符串

参数必须是指向字符数组首元素的指针 精度指定写入最大的字符数。若未指定精度，则写每个字节直到而不含首个空终止符。 若使用 l 指示符，则参数必须是指向 wchar_t 数组首元素的指针，数组会被转换成 char 数组，如同通过以零初始化转换状态调用 wcrtomb 。

不适用 不适用
char*
wchar_t*
 不适用 不适用 不适用 不适用 不适用
d
i
转换有符号整数为十进制表示 [-]dddd 。

精度指定出现的最小数位数。默认精度是 1 。
若被转换的值和精度都是 ​0​ ，则转换结果无字符。

signed char
short
int
long
long long
有符号 size_t
不适用
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
转换浮点数为 [-]ddd.ddd 样式的十进制记法。

精度指定小数点字符后出现的准确数位数。 默认精度是 6 。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用
double
double (C99)
 不适用 不适用 不适用 不适用
long double
e
E
转换浮点数为十进制指数记法。

e 转换样式使用 [-]d.ddde±dd 。
E 转换样式使用 [-]d.dddE±dd 。
指数至少含二个数位，仅当所需时使用更多数位。 若值为 ​0​ ，则指数亦为 ​0​ 。 精度指定小数点字符后出现的最小数位数。 默认精度是 6 。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用 不适用 不适用 不适用 不适用
a
A

(C99)

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

a 转换样式使用 [-]0xh.hhhp±d 。
A 转换样式使用 [-]0Xh.hhhP±d 。
若参数是正规化的浮点值，则首个十六进制数位非 0 。 若值为 ​0​ ，则指数亦为 ​0​ 。 精度指定小数点字符后出现的最小数位数。 默认精度足以准确表示该值。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用 不适用 不适用 不适用 不适用
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
返回对函数的此调用迄今为止写入的字符数。

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

signed char*
short*
int*
long*
long long*
有符号 size_t*
不适用
p 写定义指针的实现定义字符序列。 不适用 不适用 void* 不适用 不适用 不适用 不适用 不适用 不适用

浮点转换函数转换无穷大到 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 存储的值。

若转换指示非法，则行为未定义。


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

返回值

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

注解

所有这些函数调用 va_arg 至少一次，返回后 vlist 的值不确定。这些函数不调用 va_end ，而这必须由调用方进行。

不同于 vsprintf_s ， vsnprintf_s 将截断结果以适应 buffer 所指向的数组。

示例

运行此代码
#include <stdio.h>
#include <stdarg.h>
#include <time.h>
 
void debug_log(const char *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 args1;
    va_start(args1, fmt);
    va_list args2;
    va_copy(args2, args1);
    char buf[1+vsnprintf(NULL, 0, fmt, args1)];
    va_end(args1);
    vsnprintf(buf, sizeof buf, fmt, args2);
    va_end(args2);
 
    printf("%s [debug]: %s\n", time_buf, buf);
}
 
int main(void)
{
    debug_log("Logging, %d, %d, %d", 1, 2, 3);
}

可能的输出： 

02/20/15 21:58:09.072683 UTC [debug]: Logging, 1, 2, 3

引用

  • C11 标准（ISO/IEC 9899:2011）：
  • 7.21.6.8 The vfprintf function （第 326-327 页）
  • 7.21.6.10 The vprintf function （第 328 页）
  • 7.21.6.12 The vsnprintf function （第 329 页）
  • 7.21.6.13 The vsprintf function （第 329 页）
  • K.3.5.3.8 The vfprintf_s function （第 597 页）
  • K.3.5.3.10 The vprintf_s function （第 598-599 页）
  • K.3.5.3.12 The vsnprintf_s function （第 600 页）
  • K.3.5.3.13 The vsprintf_s function （第 601 页）
  • C99 标准（ISO/IEC 9899:1999）：
  • 7.19.6.8 The vfprintf function （第 292 页）
  • 7.19.6.10 The vprintf function （第 293 页）
  • 7.19.6.12 The vsnprintf function （第 294 页）
  • 7.19.6.13 The vsprintf function （第 295 页）
  • C89/C90 标准（ISO/IEC 9899:1990）：
  • 4.9.6.7 The vfprintf function
  • 4.9.6.8 The vprintf function
  • 4.9.6.9 The vsprintf function

参阅

(C95)(C95)(C95)(C11)(C11)(C11)(C11)
 打印格式化宽字符输出到 stdout 、文件流或缓冲区
使用可变参数列表
(函数)
(C99)(C11)(C11)(C11)(C11)
 打印格式化输出到 stdout 、文件流或缓冲区
(函数)
(C99)(C99)(C99)(C11)(C11)(C11)
 从 stdin 、文件流或缓冲区读取格式化输入
使用可变参数列表
(函数)
来自“https://zh.cppreference.com/mwiki/index.php?title=c/io/vfprintf&oldid=66791”