Namespaces
Variants

std:: vprintf, std:: vfprintf, std:: vsprintf, std:: vsnprintf

From cppreference.net
< cpp ‎ | io ‎ | c
定义于头文件 <cstdio>
int vprintf ( const char * format, std :: va_list vlist ) ;
(1)
int vfprintf ( std:: FILE * stream, const char * format, std :: va_list vlist ) ;
(2)
int vsprintf ( char * buffer, const char * format, std :: va_list vlist ) ;
(3)
int vsnprintf ( char * buffer, std:: size_t buf_size, const char * format, std :: va_list vlist ) ;
(4) (C++11 起)

从由 vlist 定义的内存位置加载数据,将其转换为等效的字符串形式,并将结果写入多种输出目标。

1) 将结果写入 stdout
2) 将结果写入文件流 stream
3) 将结果写入字符字符串 buffer 中。
4) 将结果写入字符字符串 buffer 中。最多写入 buf_size - 1 个字符。生成的字符字符串将以空字符结尾,除非 buf_size 为零。如果 buf_size 为零,则不会写入任何内容且 buffer 可为空指针,但返回值(不包含空终止符的待写入字节数)仍会被计算并返回。

目录

参数

stream - 用于写入的输出文件流
buffer - 指向要写入的字符串的指针
buf_size - 最大写入字符数
format - 指向空终止字符串的指针,指定数据解析格式
vlist - 包含要打印数据的可变参数列表

format 字符串由普通字节字符(除了 % 外)和转换说明组成。普通字节字符会原样复制到输出流中。每个转换说明具有以下格式:

  • 引导性的 % 字符。
  • (可选) 一个或多个用于修改转换行为的标志:
  • - :转换结果在字段内左对齐(默认为右对齐)。
  • + :有符号转换的符号始终预置于转换结果前(默认情况下仅当结果为负数时前置减号)。
  • 空格 :如果有符号转换结果不以符号字符开头或为空时,将在结果前添加空格。若存在 + 标志则此标志被忽略。
  • # :执行转换的 替代形式 。具体效果参见下表,否则行为未定义。
  • 0 :对于整数和浮点数转换,使用前导零而非 空格 字符填充字段。对于整数,若已显式指定精度则忽略此标志。其他转换使用此标志将导致未定义行为。若存在 - 标志则此标志被忽略。
  • (可选) 整数值或 * 用于指定最小字段宽度。当需要时,默认会在右对齐时左侧或左对齐时右侧填充 空格 字符。若使用 * 时,宽度由 int 类型的附加参数指定,该参数出现在待转换参数之前(若提供了精度参数,则出现在精度参数之前)。若参数值为负数,将导致指定 - 标志并采用正数字段宽度(注意:此为最小宽度:值永远不会被截断)。
  • (可选) . 后接整数或 * ,或两者皆无,用于指定转换的 精度 。当使用 * 时,精度由 int 类型的附加参数指定,该参数出现在待转换参数之前,但在提供最小字段宽度的参数(若存在)之后。若该参数值为负,则被忽略。若未使用数字或 * ,则精度默认为零。具体精度效果请参阅下表。
  • (可选) 长度修饰符 用于指定参数的大小(与转换格式说明符结合使用时,可指定对应参数的类型)。
  • 转换格式说明符。

以下格式说明符可用:

转换
说明符
说明 期望
参数类型
长度修饰符→ hh h l ll j z t L
仅自 C++11 起可用→
% 输出字面量 % 。完整转换规范必须为 %% 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

写入 单个字符

  • 参数首先被转换为 unsigned char
  • 若使用 l 修饰符,参数会先通过 %ls 格式以 wchar_t [ 2 ] 参数的形式转换为字符串。
N/A N/A
int
std::wint_t
N/A N/A N/A N/A N/A
s

写入 字符串

  • 参数必须是指向字符数组首元素的指针。
  • 精度 指定要写入的最大字节数。若未指定 精度 ,则写入直到首个空终止符(不包含该终止符)前的所有字节。
  • 若使用 l 限定符,则参数必须是指向 wchar_t 数组首元素的指针,该数组会通过调用 std::wcrtomb (使用零初始化的转换状态)转换为 char 数组。
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
d
i

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

  • 精度 指定要显示的最小数字位数。默认精度为 1
  • 如果转换后的值和精度均为 0 ,则转换结果不产生任何字符。
  • 对于 z 修饰符,期望的参数类型是 std::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
std::ptrdiff_t 的无符号版本
N/A
x
X

无符号整数 转换为十六进制表示形式 hhhh

  • 对于 x 转换,使用字母 abcdef
  • 对于 X 转换,使用字母 ABCDEF
  • 精度 指定要显示的最小数字位数。默认精度为 1
  • 如果转换值和精度均为 0 ,则转换结果不产生任何字符。
  • 替代实现 中,如果转换值非零,会在结果前添加 0x 0X 前缀。
N/A
u

unsigned integer 转换为十进制表示形式 dddd

  • Precision 指定要显示的最小数字位数。
  • 默认精度为 1
  • 如果转换后的值和精度均为 0 ,则转换结果不产生任何字符。
N/A
f
F (C++11)

浮点数 转换为 [-]ddd.ddd 风格的十进制表示法。

  • 精度 指定小数点后要显示的确切位数。
  • 默认精度为 6
  • 替代实现 中,即使没有后续数字也会写入小数点字符。
  • 关于无穷大和非数字转换风格的说明,请参阅 notes
N/A N/A
double
double (C++11)
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

(C++11)

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

  • 对于 a 转换样式,使用 [-]  0x h.hhh  p ±d 格式。
  • 对于 A 转换样式,使用 [-]  0X h.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 (C++11前) F (C++11起) 样式进行转换。
  • P 等于精度(若精度非零)、 6 (若未指定精度)或 1 (若精度为 0 )。若使用 E 样式转换得到的指数为 X
    • P > X ≥ −4 ,则使用 f F (C++11起) 样式进行转换,精度为 P − 1 − X
    • 否则,使用 e E 样式进行转换,精度为 P − 1
  • 除非请求 替代表示形式 ,否则将删除尾随零,且若无小数部分则同时删除小数点字符。
  • 关于无穷大和非数的转换样式,请参阅 注释
N/A N/A N/A N/A N/A N/A
n

返回此函数调用 目前已写入的字符数

  • 结果将 写入 到参数所指向的值中。
  • 格式说明符不得包含任何 标志 字段宽度 精度
  • 对于 z 修饰符,预期参数类型为 S * ,其中 S std:: size_t 的有符号版本。
signed char *
short *
int *
long *
long long *
N/A
p

写入一个实现定义的字符序列,用于定义 pointer (指针)。

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 。由于可变参数函数调用时会发生提升,传递这些类型的值是安全的。

固定宽度字符类型( std::int8_t 等)的正确转换规范定义在头文件 <cinttypes> 中(尽管 PRIdMAX PRIuMAX 等等同于 %jd %ju 等)。

内存写入转换说明符 %n 常成为安全漏洞的攻击目标,特别是当格式字符串依赖于用户输入时。

每个转换说明符执行后存在一个 序列点 ;这允许将多个 %n 结果存储到同一变量中,或在极端情况下,在同一调用中打印被先前 %n 修改的字符串。

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

返回值

1-3) 成功时写入的字符数量,若出现错误则为负值。
4) 成功时写入的字符数,若发生错误则返回负值。若结果字符串因 buf_size 限制被截断,函数将返回本应写入的字符总数(不包含终止空字节),此情况发生在未施加限制的条件下。

注释

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

示例

#include <cstdarg>
#include <cstdio>
#include <ctime>
#include <vector>
void debug_log(const char *fmt, ...)
{
    std::time_t t = std::time(nullptr);
    char time_buf[100];
    std::strftime(time_buf, sizeof time_buf, "%D %T", std::gmtime(&t));
    std::va_list args1;
    va_start(args1, fmt);
    std::va_list args2;
    va_copy(args2, args1);
    std::vector<char> buf(1 + std::vsnprintf(nullptr, 0, fmt, args1));
    va_end(args1);
    std::vsnprintf(buf.data(), buf.size(), fmt, args2);
    va_end(args2);
    std::printf("%s [debug]: %s\n", time_buf, buf.data());
}
int main()
{
    debug_log("Logging, %d, %d, %d", 1, 2, 3);
}

输出:

04/13/15 15:09:18 [debug]: Logging, 1, 2, 3

另请参阅

将格式化输出打印到 stdout 、文件流或缓冲区
(函数)
(C++11) (C++11) (C++11)
stdin 、文件流或缓冲区读取格式化输入
使用可变参数列表
(函数)
使用 类型擦除 参数表示形式
向支持 Unicode 的 stdout 或文件流打印
(函数)
使用 类型擦除 参数表示形式
stdout 或文件流打印
(函数)
C 文档 关于 vprintf vfprintf vsprintf vsnprintf