命名空间
变体
操作

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 起可用→ 是 是 是 是 是
% 写入字面量 %。完整的转换说明符必须是 %%。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

写入单个字符。

  • 参数首先转换为 unsigned char。
  • 如果使用 l 修饰符，参数首先转换为字符字符串，就像使用 wchar_t[2] 参数通过 %ls 转换一样。
 不适用 不适用
int
std::wint_t
 不适用 不适用 不适用 不适用 不适用
s

写入字符字符串。

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

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

  • 精度 指定要出现的最小位数。默认精度为 1。
  • 如果转换值和精度都为 ​0​，则转换结果为空字符。
  • 对于 z 修饰符，期望的参数类型是 std::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
std::ptrdiff_t 的无符号版本
 不适用
x
X

将无符号整数转换为十六进制表示 hhhh。

  • 对于 x 转换，使用字母 abcdef。
  • 对于 X 转换，使用字母 ABCDEF。
  • 精度 指定要出现的最小位数。默认精度为 1。
  • 如果转换值和精度都为 ​0​，则转换结果为空字符。
  • 在替代实现中，如果转换值非零，则在结果前添加 0x 或 0X。
 不适用
u

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

  • 精度 指定要出现的最小位数。
  • 默认精度为 1。
  • 如果转换值和精度都为 ​0​，则转换结果为空字符。
 不适用
f
F (C++11起)

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

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

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

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

(C++11)

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

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

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

  • 结果被写入到参数指向的值。
  • 说明符不得包含任何标志、字段宽度或精度。
  • 对于 z 修饰符，预期的参数类型是 S*，其中 S 是 std::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。由于在调用可变参数函数时会发生提升，因此传递这些类型的值是安全的。

固定宽度字符类型（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"