std::printf, std::fprintf, std::sprintf, std::snprintf

来自cppreference.com
< cpp‎ | io‎ | c
 
C++
 
输入/输出库
 
C 风格 I/O
类型与对象
函数
文件访问
直接输入/输出
无格式输入/输出
有格式输入
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
有格式输出
printffprintfsprintfsnprintf
(C++11)
(C++11)    
文件定位
错误处理
文件上的操作
 
在标头 <cstdio> 定义
int printf( const char* format, ... );
 (1)
int fprintf( std::FILE* stream, const char* format, ... );
 (2)
int sprintf( char* buffer, const char* format, ... );
 (3)
int snprintf( char* buffer, std::size_t buf_size, const char* format, ... );
 (4) (C++11 起)

从给定位置加载数据，转换为字符串等价版本，并将结果写入各种池。

1) 写结果到 stdout。
2) 写结果到文件流 stream。
3) 写结果到字符串 buffer。
4) 写结果到字符串 buffer。至多写 buf_size - 1 个字符。产生的字符串会以空字符终止，除非 buf_size 为零。若 buf_size 为零，则不写入任何内容，且 buffer 可以是空指针，然而依旧计算返回值（会写入的字符数，不包含空终止符）并返回。

若调用 sprintf 或 snprintf 导致在重叠的对象间发生复制，则行为未定义。（例如 sprintf(buf, "%s text", buf);）。

参数

stream - 要写入的输出文件流
buffer - 指向要写入的字符串的指针
buf_size - 写入至多 buf_size - 1 个字符，再加上空终止符
format - 指向空终止多字节字符串的指针，指定如何判读数据
... - 指定要打印数据的实参。若任何实参经过默认转换后的类型不是对应转换指示符所期望的类型，或若实参数量少于 format 的要求，则行为未定义。若有多于 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 存储的值。

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

返回值

1,2) 若成功则为写入的字符数，若发生错误则为负值。
3) 若成功则为写入的字符数（不包含空终止字符），若发生错误则为负值。
4) 若成功则为会写入充分大缓冲区的字符数（不包含空终止字符），若发生错误则为负值。从而，当且仅当返回值非负且小于 buf_size 才完全写入（空终止）。

注解

POSIX 规定在错误时设置 errno。它还规定额外的转换指示，最值得注意的是对实参重排序的支持（紧随 % 后的 n$ 指示第 n 个实参）。

以零 buf_size 和用空指针作为 buffer 调用 std::snprintf 可用于确定容纳输出的所需缓冲区大小： 

auto fmt = "sqrt(2) = %f";
int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2));
std::vector<char> buf(sz + 1); // 注意为空终止符 +1
std::sprintf(buf.data(), fmt, std::sqrt(2)); // 确定可以放入

示例

运行此代码
#include <cinttypes>
#include <cstdint>
#include <cstdio>
#include <limits>
 
int main()
{
    const char s[] = "Hello";
    std::printf("字符串:\n"); // 同 std::puts("字符串:");
    std::printf("\t[%10s]\n", s);
    std::printf("\t[%-10s]\n", s);
    std::printf("\t[%*s]\n", 10, s);
    std::printf("\t[%-10.*s]\n", 4, s);
    std::printf("\t[%-*.*s]\n", 10, 4, s);
 
    std::printf("字符:\t%c %%\n", 65);
 
    std::printf("整数:\n");
    std::printf("\t十进制:    \t%i %d %.6i %i %.0i %+i %i\n",
                                  1, 2,   3, 0,   0,  4,-4);
    std::printf("\t十六进制:\t%x %x %X %#x\n",
                                  5,10,10,  6);
    std::printf("\t八进制:      \t%o %#o %#o\n",
                                 10, 10,  4);
 
    std::printf("浮点:\n");
    std::printf("\t舍入:\t\t%f %.0f %.32f\n", 1.5, 1.5, 1.3);
    std::printf("\t填充:\t\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    std::printf("\t科学表示:\t%E %e\n", 1.5, 1.5);
    std::printf("\t十六进制:\t%a %A\n", 1.5, 1.5);
    std::printf("\t特殊值:\t\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0);
 
    std::printf("变量宽度控制:\n");
    std::printf("\t右对齐变量宽度: '%*c'\n", 5, 'x');
    int r = std::printf("\t左对齐变量宽度: '%*c'\n", -5, 'x');
    std::printf("(最后一次 printf 打印了 %d 个字符)\n", r);
 
    std::printf("固定宽度类型:\n");
    std::uint32_t val = std::numeric_limits<std::uint32_t>::max();
    std::printf("\t最大的 32 位值为 %" PRIu32 " 或 %#" PRIx32 "\n",
                                        val,            val);
}

可能的输出： 

字符串:
	[     Hello]
	[Hello     ]
	[     Hello]
	[Hell      ]
	[Hell      ]
字符:	A %
整数:
	十进制:    	1 2 000003 0  +4 -4
	十六进制:	5 a A 0x6
	八进制:      	12 012 04
浮点:
	舍入:		1.500000 2 1.30000000000000004440892098500626
	填充:		01.50 1.50  1.50
	科学表示:	1.500000E+00 1.500000e+00
	十六进制:	0x1.8p+0 0X1.8P+0
	特殊值:		0/0=-nan 1/0=inf
变量宽度控制:
	右对齐变量宽度: '    x'
	左对齐变量宽度: 'x    '
(最后一次 printf 打印了 32 个字符)
固定宽度类型:
	最大的 32 位值为 4294967295 或 0xffffffff

参阅

 打印有格式宽字符输出到 stdout、文件流或缓冲区
(函数)
(C++11)
 使用可变实参列表
打印有格式输出到 stdout、文件流或缓冲区
(函数)
写字符串到文件流
(函数)
从 stdin、文件流或缓冲区读取有格式输入
(函数)
(C++17)
 转换整数或浮点值为字符序列
(函数)
(C++23)
 将参数的格式化表达输出到 stdout 或文件缓冲区
(函数模板)
(C++23)
 将参数的格式化表达输出到 stdout 或文件缓冲区，输出完成后换行
(函数模板)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/io/c/fprintf&oldid=84538”