命名空间
变体
操作

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 );
 (until C99)
int vprintf( const char* restrict format, va_list vlist );
 (since C99)
(2)
int vfprintf( FILE* stream, const char* format, va_list vlist );
 (until C99)
int vfprintf( FILE* restrict stream, const char* restrict format,
              va_list vlist );
 (since C99)
(3)
int vsprintf( char* buffer, const char* format, va_list vlist );
 (until C99)
int vsprintf( char* restrict buffer, const char* restrict format,
              va_list vlist );
 (since C99)
int vsnprintf( char* restrict buffer, size_t bufsz,
               const char* restrict format, va_list vlist );
 (4) (since C99)
int vprintf_s( const char* restrict format, va_list vlist );
 (5) (since C11)
int vfprintf_s( FILE* restrict stream, const char* restrict format,
                va_list vlist );
 (6) (since C11)
int vsprintf_s( char* restrict buffer, rsize_t bufsz,
                const char* restrict format, va_list vlist );
 (7) (since C11)
int vsnprintf_s( char* restrict buffer, rsize_t bufsz,
                 const char* restrict format, va_list vlist );
 (8) (since C11)

从由 vlist 定义的位置加载数据，将其转换为等效的字符串，并将结果写入各种接收器。

1) 将结果写入 stdout。
2) 将结果写入文件流 stream。
3) 将结果写入字符串 buffer。
4) 将结果写入字符串 buffer。 最多写入 bufsz - 1 个字符。 结果字符串将以空字符终止，除非 bufsz 为零。 如果 bufsz 为零，则不写入任何内容，并且 buffer 可以为空指针，但是返回值（将要写入的字节数，不包括空终止符）仍然被计算并返回。
5-8) 与 (1-4) 相同，除了在运行时检测到以下错误并调用当前安装的 约束处理函数
  • 转换说明符 %n 出现在 format 中
  • 对应于 %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 - 指向空终止字符的字符串的指针，指定如何解释数据
vlist - 包含要打印数据的可变参数列表。

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

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

以下格式说明符可用

转换
说明符		 解释 预期
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅自 C99 起可用→ % % % % %
% 写入文字 %。 完整的转换规范必须为 %%。 N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

写入单个字符。

  • 参数首先转换为 unsigned char。
  • 如果使用 l 修饰符，则参数首先转换为字符串，就像使用带有 wchar_t[2] 参数的 %ls 一样。
 N/A N/A
int
wint_t
 N/A N/A N/A N/A N/A
s

写入字符串。

  • 参数必须是指向字符数组初始元素的指针。
  • 精度指定要写入的最大字节数。 如果未指定精度，则写入每个字节，直到但不包括第一个空终止符。
  • 如果使用 l 说明符，则参数必须是指向 wchar_t 数组初始元素的指针，该数组转换为 char 数组，就像调用 wcrtomb 并使用零初始化的转换状态一样。
 N/A N/A
char*
wchar_t*
 N/A N/A N/A N/A N/A
d
i

将有符号整数转换为十进制表示形式 [-]dddd。

  • 精度指定要出现的最小位数。 默认精度为 1。
  • 如果转换后的值和精度均为 ​0​，则转换不会产生任何字符。
  • 对于 z 修饰符，预期的参数类型是 size_t 的有符号版本。
signed char
short
int
long
long long
※
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​，则转换不会产生任何字符。
  • 在替代实现中，如果转换后的值不为零，则在结果前缀 0x 或 0X。
 N/A
u

将无符号整数转换为十进制表示形式 dddd。

  • 精度指定要出现的最小位数。
  • 默认精度为 1。
  • 如果转换后的值和精度均为 ​0​，则转换不会产生任何字符。
 N/A
f
F (C99)

将浮点数转换为十进制表示法，样式为 [-]ddd.ddd。

  • 精度指定小数点字符后要出现的准确位数。
  • 默认精度为 6。
  • 在替代实现中，即使后面没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A
double
double (C99)
 N/A N/A N/A N/A
long double
e
E

将浮点数转换为十进制指数表示法。

  • 对于 e 转换样式，使用 [-]d.ddd e±dd。
  • 对于 E 转换样式，使用 [-]d.ddd E±dd。
  • 指数至少包含两位数字，仅在必要时才使用更多数字。
  • 如果值为 ​0​，则指数也为 ​0​。
  • 精度指定小数点字符后要出现的准确位数。
  • 默认精度为 6。
  • 在替代实现中，即使后面没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
a
A

(C99)

将浮点数转换为十六进制指数表示法。

  • 对于 a 转换样式，使用 [-] 0xh.hhh p±d。
  • 对于 A 转换样式，使用 [-] 0Xh.hhh P±d。
  • 如果参数是规范化的浮点值，则第一个十六进制数字不是 0。
  • 如果值为 ​0​，则指数也为 ​0​。
  • 精度指定十六进制小数点字符后要出现的准确位数。
  • 默认精度足以精确表示该值。
  • 在替代实现中，即使后面没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
g
G

根据值和精度，将浮点数转换为十进制或十进制指数表示法。

  • 对于 g 转换样式，将执行样式 e 或 f 的转换。
  • 对于 G 转换样式，将执行样式 E 或 f(until C99)F(since C99) 的转换。
  • 设 P 等于精度（如果非零），如果未指定精度，则为 6，如果精度为 ​0​，则为 1。 然后，如果样式为 E 的转换的指数为 X
    • 如果 P > X ≥ −4，则转换的样式为 f 或 F(since C99)，精度为 P − 1 − X。
    • 否则，转换的样式为 e 或 E，精度为 P − 1。
  • 除非请求替代表示，否则将删除尾随零，如果没有小数部分，则删除小数点字符。
  • 有关无穷大和非数字转换样式，请参见注释。
 N/A N/A N/A N/A N/A N/A
n

返回此函数调用到目前为止写入的字符数。

  • 结果写入到参数指向的值。
  • 规范可能不包含任何标志、字段宽度或精度。
  • 对于 z 修饰符，预期的参数类型为 S*，其中 S 是 size_t 的有符号版本。
signed char*
short*
int*
long*
long long*
※
N/A
p

写入实现定义的字符序列，用于定义指针。

 N/A N/A
void*
 N/A N/A N/A N/A N/A N/A
注意

浮点转换函数将无穷大转换为 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 函数系列不支持该说明符(since C11)。

在每个转换说明符的操作之后都有一个序列点； 这允许在同一变量中存储多个 %n 结果，或者作为边缘情况，在同一调用中打印由较早的 %n 修改的字符串。

如果转换规范无效，则行为未定义。

[编辑] 返回值

1-3) 如果成功，则为写入的字符数；如果发生错误，则为负值。
4) 如果成功，则为写入的字符数；如果发生错误，则为负值。 如果由于 buf_size 限制而导致结果字符串被截断，则函数返回如果未施加限制将要写入的总字符数（不包括终止空字节）。
5,6) 传输到输出流的字符数；如果发生输出错误、运行时约束违反错误或编码错误，则为负值。
7) 写入 buffer 的字符数，不包括空字符（只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX，则始终写入空字符），或者在运行时约束违反时为零，在编码错误时为负值
8) 将要写入 buffer 的字符数（不包括终止空字符，只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX，则始终写入），如果忽略 bufsz，则为该字符数，如果发生运行时约束违反或编码错误，则为负值

[编辑] 注意

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

与 vsprintf_s 不同，vsnprintf_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: TBD)
  • 7.21.6.10 vprintf 函数 (p: TBD)
  • 7.21.6.12 vsnprintf 函数 (p: TBD)
  • 7.21.6.13 vsprintf 函数 (p: TBD)
  • K.3.5.3.8 vfprintf_s 函数 (p: TBD)
  • K.3.5.3.10 vprintf_s 函数 (p: TBD)
  • K.3.5.3.12 vsnprintf_s 函数 (p: TBD)
  • K.3.5.3.13 vsprintf_s 函数 (p: TBD)
  • 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”