Xi Xu's More Things

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

来自cppreference.com
< cpp‎ | io‎ | c
 
C++
 
输入/输出库
 
C 风格 I/O
类型与对象
函数
文件访问
直接输入/输出
无格式输入/输出
有格式输入
(C++11)(C++11)(C++11)
有格式输出
(C++11)
vprintfvfprintfvsprintfvsnprintf
(C++11)
文件定位
错误处理
文件上的操作
 
在标头 <cstdio> 定义
int vprintf( const char* format, va_list vlist );
 (1)
int vfprintf( std::FILE* stream, const char* format, va_list vlist );
 (2)
int vsprintf( char* buffer, const char* format, va_list vlist );
 (3)
int vsnprintf( char* buffer, std::size_t buf_size, const char* format, 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 - 指向空终止字符串的指针，字符串指定如何转译数据。

格式字符串由普通多字节字符（除了 % ）和转换指示构成，前者被复制到输出流而无更改。每个转换指示拥有下列格式：

  • 引入的 % 字符
  • (可选)一或多个修改转换行为的标签：
  • - ：转换结果在域内左校正（默认为右校正）
  • + ：有符号转换的符号始终前置于转换结果（默认结果前置负号仅当它为负）
  • 空格：若有符号转换的结果不以符号开始，或为空，则前置空格于结果。若存在 + 标签则忽略空格。
  • # ：进行替用形式的转换。准确的效果见下表，其他情况下行为未定义。
  • 0 ：对于整数和浮点数转换，使用前导零代替空格字符填充域。对于整数，若显式指定精度，则忽略此标签。对于其他转换，使用此标签导致未定义行为。若存在 - 标签则忽略 0 。
  • (可选)指定最小域宽的整数值或 * 。若有要求，则结果会以空格字符（默认情况）填充，在右校正时于左，左校正时于右。使用 * 的情况下，以一个额外的 int 类型参数指定宽度。若参数值为负数，则它导致指定 - 标签和正域宽。（注意：这是最小宽度：决不被截断值）。
  • (可选)后随整数或 * 或两者皆无的 . 指示转换的精度。在使用 * 的情况下，精度由额外的 int 类型参数指定。若此参数的值为负数，则它被忽略。若既不使用数字亦不使用 * ，则精度采用零。精度的准确效果见下表。
  • (可选)指定参数大小的长度修饰符
  • 转换格式指示符

下列格式指示符可用：

转换
指示符 		解释 参数类型
长度修饰符 hh

(C++11)

h （无） l ll

(C++11)

j

(C++11)

z

(C++11)

t

(C++11)

L
% 写字面的 % 。完整转换指示必须是 %% 。 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
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​ ，则转换结果无字符。

signed char
short
int
long
long long
intmax_t
有符号 size_t
ptrdiff_t
不适用
o
转换无符号整数为八进制表示 oooo 。

精度指定出现的最小数位数。默认精度是 1 。 若被转换值和精度都是 ​0​ ，则转换结果无字符。 在替用实现中精度按需增加，以写入一个前导零。 在此情况下若被转换值和精度都是 ​0​ ，则写入单个 ​0​ 。

unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
uintmax_t
size_t
ptrdiff_t 的无符号版本
 不适用
x
X
转换无符号整数为十六进制表示 hhhh 。

x 转换使用字母 abcdef 。
X 转换使用 ABCDEF 。
精度指定出现的最小数位数。默认精度是 1 。 若被转换值和精度都是 ​0​ ，则转换结果无字符。 在替用实现中若被转换值为非零则结果有 0x 或 0X 前缀。

不适用
u
转换无符号整数为十进制表示 dddd 。

精度指定出现的最小数位数。 默认精度是 1 。 若被转换值和精度都是 ​0​ ，则转换结果无字符。

不适用
f
F
转换浮点数为 [-]ddd.ddd 样式的十进制记法。

精度指定小数点字符后出现的准确数位数。 默认精度是 6 。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用
double
double (C++11)
 不适用 不适用 不适用 不适用
long double
e
E
转换浮点数为十进制指数记法。

e 转换样式使用 [-]d.ddde±dd 。
E 转换样式使用 [-]d.dddE±dd 。
指数至少含二个数位，仅当所需时使用更多数位。 若值为 ​0​ ，则指数亦为 ​0​ 。 精度指定小数点字符后出现的最小数位数。 默认精度是 6 。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用 不适用 不适用 不适用 不适用
a
A

(C++11)

转换浮点数为十六进制记法。

a 转换样式使用 [-]0xh.hhhp±d 。
A 转换样式使用 [-]0Xh.hhhP±d 。
若参数是正规化的浮点值，则首个十六进制数位非 0 。 若值为 ​0​ ，则指数亦为 ​0​ 。 精度指定小数点字符后出现的最小数位数。 默认精度足以准确表示该值。 在替用实现中即使没有小数点后数位也写小数点。 无穷大和非数的转换样式见注意。

不适用 不适用 不适用 不适用 不适用 不适用
g
G
转换浮点数为十进制小数或十进制指数记法，依赖于值和精度。

g 转换样式将进行带样式 e 或 f 的转换。
G 转换样式将进行带样式 E 或 F 的转换。
令 P 等于精度，若它非零，若精度未指定则为 6 ，若精度为 ​0​ 则等于 1 。然后，若带样式 E 的转换会有指数 X ，则：

  • 若 P > X ≥ −4 ，则转换带 f 或 F 风格，及精度 P − 1 − X 。
  • 否则，转换带 e 或 E 风格，及精度 P − 1 。

除非要求替用表示，否则末尾零会被移除，且若不留下小数部分则小数点亦被移除。 无穷大和非数的转换样式见注意。

不适用 不适用 不适用 不适用 不适用 不适用
n
返回对函数的此调用迄今为止写入的字符数。

结果被写入到参数所指向的值。 该指示不可含有任何标签、域宽或精度。

signed char*
short*
int*
long*
long long*
intmax_t*
有符号 size_t*
ptrdiff_t*
 不适用
p 写定义指针的实现定义字符序列。 不适用 不适用 void* 不适用 不适用 不适用 不适用 不适用 不适用

浮点转换函数转换无穷大到 inf 或 infinity 。使用哪个是由实现定义的。

非数转换成 nan 或 nan(char_sequence) 。使用哪个是由实现定义的。

转换 F 、 E 、 G 、 A 替代上面输出 INF 、 INFINITY 、 NAN。

尽管 %c 期待 int 参数，传递 char 是安全的，因为在调用变参数函数时发生整数提升。

定宽整数类型（ int8_t 等）的正确转换指示定义于头文件 <cinttypes> （尽管 PRIdMAX 、 PRIuMAX 等就是 %jd 、 %ju 等的别名）。

内存写入转换指示符 %n 是安全漏洞的常见目标，这里格式字符串依赖用户输入，而有边界检查的 printf_s 系列函数不支持此转换指示符。

在每个转换指示符的行动后有一个序列点；这允许于同一变量多次存入 %n 的结果，并在同一此调用中打印出先前以 %n 存储的值。

若转换指示非法，则行为未定义。


vlist - 含有要打印数据的可变参数列表

返回值

1-3) 若成功则为写入的字符数，或若出现错误则为负值。
4) 若成功则为写入的字符数，或若出现错误则为负值。若结果字符串由于 buf_size 限制被截断，则函数返回假如未强加极限则本应写入的总字节数（不包含空终止字符）。

注解

所有这些函数调用 va_arg 至少一次，返回后 arg 的值不确定。这些函数不调用 va_end ，而这必须由调用方进行。

示例

运行此代码
#include <vector>
#include <cstdio>
#include <cstdarg>
#include <ctime>
 
void debug_log(const char *fmt, ...)
{
    auto t = std::time(nullptr);
    char time_buf[100];
    std::strftime(time_buf, sizeof time_buf, "%D %T", std::gmtime(&t));
    va_list args1;
    va_start(args1, fmt);
    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、文件流或缓冲区读取有格式输入
(函数)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/io/c/vfprintf&oldid=75132”