命名空间
变体
操作

vprintf, vfprintf, vsprintf, vsnprintf, vprintf_s, vfprintf_s, vsprintf_s, vsnprintf_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)  
直接输入/输出
格式化输出
vprintfvfprintfvsprintfvsnprintfvprintf_svfprintf_svsprintf_svsnprintf_s
(C99)(C11)(C11)(C11)(C11)
(C95)(C95)(C95)(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 vlist );
 (5) (C11 起)
int vfprintf_s( FILE* restrict stream, const char* restrict format,
                va_list vlist );
 (6) (C11 起)
int vsprintf_s( char* restrict buffer, rsize_t bufsz,
                const char* restrict format, va_list vlist );
 (7) (C11 起)
int vsnprintf_s( char* restrict buffer, rsize_t bufsz,
                 const char* restrict format, va_list vlist );
 (8) (C11 起)

从 vlist 定义的位置加载数据，将其转换为相应的字符字符串，并将结果写入各种目标。

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

目录

[编辑] 参数

stream - 要写入的输出文件流
buffer - 要写入的字符字符串指针
bufsz - 最多可写入 bufsz - 1 个字符，外加空终止符
format - 指向以 null 结尾的字符字符串的指针，指定如何解释数据
vlist - 包含要打印的数据的可变参数列表。

format 字符串由普通字节字符（除了 %）组成，它们被不变地复制到输出流中，以及转换说明符。每个转换说明符具有以下格式：

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

以下格式说明符可用：

转换
说明符		 解释 预期
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅在 C99 之后可用→ 是 是 是 是 是
% 写入字面量 %。完整的转换说明符必须是 %%。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
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​，则转换结果不包含任何字符。
  • 对于 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-3) 如果成功，写入的字符数；如果发生错误，则为负值。
4) 如果成功，写入的字符数；如果发生错误，则为负值。如果由于 buf_size 限制导致生成的字符串被截断，函数将返回将被写入的总字符数（不包括终止空字节），如果未施加限制的话。
5,6) 传输到输出流的字符数；如果发生输出错误、运行时约束违规错误或编码错误，则为负值。
7) 写入 buffer 的字符数，不包括空字符（只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX，则总是写入空字符），在运行时约束违规时为零，在编码错误时为负值
8) 如果忽略 bufsz，将被写入 buffer 的字符数，不包括终止空字符（只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX，则总是写入空字符），或者在运行时约束违规或编码错误时为负值

[编辑] 注意

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

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

Microsoft CRT 中 vsnprintf_s 的实现不符合 C 标准。Microsoft 的版本在第三个位置有一个额外的参数 size_t count，其中包含要写入的最大字符数，不包括空终止符。此参数可能与通过参数 size_t bufsz 提供的缓冲区大小不同。

[编辑] 示例

运行此代码
#include <stdarg.h>
#include <stdio.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

[编辑] 参考

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.21.6.8 vfprintf 函数 (p: 待定)
  • 7.21.6.10 vprintf 函数 (p: 待定)
  • 7.21.6.12 vsnprintf 函数 (p: 待定)
  • 7.21.6.13 vsprintf 函数 (p: 待定)
  • K.3.5.3.8 vfprintf_s 函数 (p: 待定)
  • K.3.5.3.10 vprintf_s 函数 (p: 待定)
  • K.3.5.3.12 vsnprintf_s 函数 (p: 待定)
  • K.3.5.3.13 vsprintf_s 函数 (p: 待定)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.21.6.8 vfprintf 函数 (p: 238)
  • 7.21.6.10 vprintf 函数 (p: 239)
  • 7.21.6.12 vsnprintf 函数 (p: 239-240)
  • 7.21.6.13 vsprintf 函数 (p: 240)
  • K.3.5.3.8 vfprintf_s 函数 (p: 434)
  • K.3.5.3.10 vprintf_s 函数 (p: 435)
  • K.3.5.3.12 vsnprintf_s 函数 (p: 436-437)
  • K.3.5.3.13 vsprintf_s 函数 (p: 437)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.21.6.8 vfprintf 函数 (p: 326-327)
  • 7.21.6.10 vprintf 函数 (p: 328)
  • 7.21.6.12 vsnprintf 函数 (p: 329)
  • 7.21.6.13 vsprintf 函数 (p: 329)
  • K.3.5.3.8 vfprintf_s 函数 (p: 597)
  • K.3.5.3.10 vprintf_s 函数 (p: 598-599)
  • K.3.5.3.12 vsnprintf_s 函数 (p: 600)
  • K.3.5.3.13 vsprintf_s 函数 (p: 601)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.19.6.8 vfprintf 函数 (p: 292)
  • 7.19.6.10 vprintf 函数 (p: 293)
  • 7.19.6.12 vsnprintf 函数 (p: 294)
  • 7.19.6.13 vsprintf 函数 (p: 295)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 4.9.6.7 vfprintf 函数
  • 4.9.6.8 vprintf 函数
  • 4.9.6.9 vsprintf 函数

[编辑] 参见

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