命名空间
变体
操作

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

来自 cppreference.cn
< cpp‎ | io‎ | c
 
C++
 
输入/输出库
 
C 风格 I/O
类型与对象
函数
文件访问
直接输入/输出
非格式化输入/输出
格式化输入
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
格式化输出
(C++11)
vprintfvfprintfvsprintfvsnprintf
(C++11)    
文件定位
错误处理
文件操作
 
定义于头文件 <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 起可用→ 是 是 是 是 是
% 写入字面量 %。完整的转换规范必须为 %%。 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
std::wint_t
 N/A N/A N/A N/A N/A
s

写入字符串。

  • 参数必须是指向字符数组初始元素的指针。
  • 精度指定要写入的最大字节数。如果未指定精度，则写入每个字节，直到但不包括第一个空终止符。
  • 如果使用 l 说明符，则参数必须是指向 wchar_t 数组初始元素的指针，该数组转换为 char 数组，如同调用 std::wcrtomb 并带有零初始化的转换状态。
 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

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

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

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

  • 精度指定小数点字符后要显示的确切位数。
  • 默认精度为 6。
  • 在备用实现中，即使小数点后没有数字，也会写入小数点字符。
  • 有关无穷大和非数字转换样式，请参见注解。
 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 转换样式，使用 [-] 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(直到 C++11)F(自 C++11 起) 的转换。
  • 令 P 等于精度（如果非零），如果未指定精度，则为 6，如果精度为 ​0​，则为 1。然后，如果样式 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

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

 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

[编辑] 参见

(C++11)
 将格式化输出打印到 stdout、文件流或缓冲区
(函数) [编辑]
(C++11)(C++11)(C++11)
 从 stdin、文件流或缓冲区读取格式化输入
使用可变参数列表
(函数) [编辑]
(C++23)
 使用类型擦除参数表示，打印到支持 Unicode 的 stdout 或文件流
(函数) [编辑]
(C++23)
 使用类型擦除参数表示，打印到 stdout 或文件流
(函数) [编辑]
C 文档 关于 vprintf, vfprintf, vsprintf, vsnprintf
取自“https://cppreference.cn/mwiki/index.php?title=cpp/io/c/vfprintf&oldid=158713”