命名空间
变体
操作

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

来自 cppreference.com
< cpp‎ | io‎ | c
 
 
 
C 样式 I/O
类型和对象
函数
文件访问
直接输入/输出
无格式输入/输出
格式化输入
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
格式化输出
printffprintfsprintfsnprintf
(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 可以是空指针,但是返回值(不包括空终止符的写入字节数)仍将被计算并返回。

如果调用 sprintfsnprintf 导致在重叠的对象之间进行复制,则行为未定义(例如 sprintf(buf, "%s text", buf);)。

内容

[编辑] 参数

stream - 要写入的输出文件流
buffer - 指向要写入的字符字符串的指针
buf_size - 最多可以写入 buf_size - 1 个字符,加上空终止符
format - 指向以空字符结尾的多字节字符串的指针,指定如何解释数据
... - 指定要打印数据的参数。如果 默认转换 后的任何参数与相应的转换说明符期望的类型不符,或者参数少于 format 所需的参数,则行为未定义。如果参数多于 format 所需的参数,则将计算并忽略多余的参数

format 字符串由普通字节字符(除 % 外)组成,这些字符将原样复制到输出流中,以及转换说明符。每个转换说明符都具有以下格式

  • 引导 % 字符。
  • (可选) 一个或多个修改转换行为的标志
  • -: 转换结果在字段中左对齐(默认情况下右对齐)。
  • +: 有符号转换的符号始终会附加到转换结果之前(默认情况下,只有在结果为负时才用减号作为前缀)。
  • 空格: 如果有符号转换的结果不是以符号字符开头,或者为空,则在结果之前附加空格。如果存在 + 标志,则忽略它。
  • #: 执行转换的替代形式。有关确切的效果,请参见下表,否则行为未定义。
  • 0: 对于整数和浮点数转换,使用前导零来填充字段,而不是空格字符。对于整数,如果显式指定精度,则忽略它。对于使用此标志的其他转换,会导致未定义的行为。如果存在 - 标志,则忽略它。
  • (可选) 指定最小字段宽度的整数或 *。如果需要,结果将用空格字符(默认情况下)在右对齐时从左侧填充,或在左对齐时从右侧填充。在使用 * 的情况下,宽度由 int 类型的附加参数指定,该参数出现在要转换的参数之前,以及提供精度的参数(如果提供)。如果参数的值为负数,则会指定 - 标志,并且字段宽度为正数(注意:这是最小宽度:值永远不会被截断)。
  • (可选) 后跟整数或 *,或者两者都不,指定转换的精度。在使用 * 的情况下,精度int 类型的附加参数指定,该参数出现在要转换的参数之前,但在提供最小字段宽度的参数(如果提供)之后。如果此参数的值为负数,则会忽略它。如果既没有使用数字也没有使用 *,则精度将作为零。有关精度的确切效果,请参见下表。
  • (可选) 长度修饰符,指定参数的大小(与转换格式说明符结合使用,它指定了相应参数的类型)。
  • 转换格式说明符。

以下格式说明符可用

转换
说明符
解释 预期
参数类型
长度
修饰符
hh

(C++11)

h (无) l ll

(C++11)

j

(C++11)

z

(C++11)

t

(C++11)

L
% 写入文字 %。完整的转换说明符必须为 %% N/A N/A N/A N/A N/A N/A N/A N/A N/A
c
写入单个字符

参数首先转换为 unsigned char。如果使用了l 修饰符,则参数首先转换为字符字符串,就像使用%lswchar_t[2] 参数一样。

N/A N/A
int
wint_t
N/A N/A N/A N/A N/A
s
写入字符字符串

参数必须是指向字符数组的初始元素的指针。精度指定要写入的最大字节数。如果未指定精度,则写入直到但不包括第一个空终止符的每个字节。如果使用l说明符,则参数必须是指向wchar_t数组的初始元素的指针,该指针将通过对wcrtomb的调用(使用零初始化的转换状态)转换为char数组。

N/A N/A
char*
wchar_t*
N/A N/A N/A N/A N/A
d
i
有符号整数转换为十进制表示形式[-]dddd

精度指定要显示的最小位数。默认精度为1

如果转换后的值和精度都为0,则转换结果不产生任何字符。

signed char
short
int
long
long long
intmax_t
signed size_t
ptrdiff_t
N/A
o
无符号整数转换为八进制表示形式oooo

精度指定要显示的最小位数。默认精度为1。如果转换后的值和精度都为0,则转换结果不产生任何字符。在替代实现中,如果需要,精度会增加,以写入一个前导零。在这种情况下,如果转换后的值和精度都为0,则会写入单个0

unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
uintmax_t
size_t
ptrdiff_t的无符号版本
N/A
x
X
无符号整数转换为十六进制表示形式hhhh

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

N/A
u
无符号整数转换为十进制表示形式dddd

精度指定要显示的最小位数。默认精度为1。如果转换后的值和精度都为0,则转换结果不产生任何字符。

N/A
f
F
浮点数转换为样式为[-]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.ddde±dd
对于E转换样式,使用[-]d.dddE±dd
指数至少包含两位数字,只有在必要时才会使用更多位数字。如果值为0,则指数也为0精度指定小数点字符后要显示的确切位数。默认精度为6。在替代实现中,即使没有数字跟随,也会写入小数点字符。有关无穷大和小数转换样式,请参见说明。

N/A N/A N/A N/A N/A N/A
a
A

(C++11)

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

对于a转换样式,使用[-]0xh.hhhp±d
对于A转换样式,使用[-]0Xh.hhhP±d
如果参数是规范化的浮点数,则第一个十六进制数字不为0。如果值为0,则指数也为0精度指定十六进制点字符后要显示的确切位数。默认精度足以精确地表示该值。在替代实现中,即使没有数字跟随,也会写入小数点字符。有关无穷大和小数转换样式,请参见说明。

N/A N/A N/A N/A N/A N/A
g
G
根据值和精度,将浮点数转换为十进制或十进制指数表示法。

对于g转换样式,将执行样式为ef的转换。
对于G转换样式,将执行样式为EF的转换。
P等于非零精度,如果未指定精度则为6,如果精度为0则为1。然后,如果样式为E的转换的指数为X

  • 如果P > X ≥ −4,则转换的样式为fF,精度为P − 1 − X
  • 否则,转换的样式为eE,精度为P − 1

除非请求替代表示,否则尾随零将被删除,如果剩下的小数部分,则小数点字符也会被删除。有关无穷大和小数转换样式,请参见说明。

N/A N/A N/A N/A N/A N/A
n
返回此对函数的调用目前为止写入的字符数

结果写入到参数指向的值。规范可能不包含任何标志字段宽度精度



signed char*
short*
int*
long*
long long*
intmax_t*
signed size_t*
ptrdiff_t*
N/A
p 写入定义指针的实现定义的字符序列。 N/A N/A void* N/A N/A N/A N/A N/A N/A

浮点数转换函数将无穷大转换为infinfinity。使用哪一个是实现定义的。

NaN 转换为nannan(char_sequence)。使用哪一个是实现定义的。

转换FEGA输出INFINFINITYNAN

即使%c需要int参数,但由于在调用可变参数函数时发生的整数提升,传递char是安全的。

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

内存写入转换说明符%n是安全漏洞的常见目标,其中格式字符串依赖于用户输入,并且不受边界检查的printf_s函数族支持。

每个转换说明符的操作之后都有一个序列点;这允许将多个%n结果存储在同一个变量中,或者作为一种边缘情况,在同一个调用中打印由更早的%n修改的字符串。

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

[edit] 返回值

1,2) 如果成功则写入的字符数,如果发生错误则为负值。
3) 如果成功则写入的字符数(不包括终止空字符),如果发生错误则为负值。
4) 如果成功则为足够大的缓冲区将写入的字符数(不包括终止空字符),如果发生错误则为负值。因此,仅当返回值非负且小于buf_size时,才表示已完全写入(以空终止符结尾的)输出。

[edit] 说明

POSIX 指定,如果发生错误,则设置errno。它还指定了额外的转换规范,最值得注意的是对参数重新排序的支持(n$紧跟在%之后表示第 nth 个参数)。

使用零buf_sizebuffer的空指针调用std::snprintf非常有用(当双重调用的开销可以接受时),以确定包含输出所需的缓冲区大小。

auto fmt = "sqrt(2) = %f";
int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2));
std::vector<char> buf(sz + 1); // note +1 for null terminator
std::sprintf(buf.data(), fmt, std::sqrt(2)); // certain to fit

[edit] 示例

#include <cinttypes>
#include <cstdint>
#include <cstdio>
#include <limits>
 
int main()
{
    const char* s = "Hello";
    std::printf("Strings:\n"); // same as std::puts("Strings:");
    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("Characters:\t%c %%\n", 'A');
 
    std::printf("Integers:\n");
    std::printf("\tDecimal:    \t%i %d %.6i %i %.0i %+i %i\n",
                                  1, 2,   3, 0,   0,  4,-4);
    std::printf("\tHexadecimal:\t%x %x %X %#x\n",
                                  5,10,10,  6);
    std::printf("\tOctal:      \t%o %#o %#o\n",
                                 10, 10,  4);
 
    std::printf("Floating point:\n");
    std::printf("\tRounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3);
    std::printf("\tPadding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    std::printf("\tScientific:\t%E %e\n", 1.5, 1.5);
    std::printf("\tHexadecimal:\t%a %A\n", 1.5, 1.5);
    std::printf("\tSpecial values:\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0);
 
    std::printf("Variable width control:\n");
    std::printf("\tright-justified variable width: '%*c'\n", 5, 'x');
    int r = std::printf("\tleft-justified variable width : '%*c'\n", -5, 'x');
    std::printf("(the last printf printed %d characters)\n", r);
 
    std::printf("Fixed-width types:\n");
    std::uint32_t val = std::numeric_limits<std::uint32_t>::max();
    std::printf("\tLargest 32-bit value is %" PRIu32 " or %#" PRIx32 "\n",
                                                 val,            val);
}

可能的输出

Strings:
	[     Hello]
	[Hello     ]
	[     Hello]
	[Hell      ]
	[Hell      ]
Characters:	A %
Integers:
	Decimal:    	1 2 000003 0  +4 -4
	Hexadecimal:	5 a A 0x6
	Octal:      	12 012 04
Floating point:
	Rounding:	1.500000 2 1.30000000000000004440892098500626
	Padding:	01.50 1.50  1.50
	Scientific:	1.500000E+00 1.500000e+00
	Hexadecimal:	0x1.8p+0 0X1.8P+0
	Special values:	0/0=-nan 1/0=inf
Variable width control:
	right-justified variable width: '    x'
	left-justified variable width : 'x    '
(the last printf printed 41 characters)
Fixed-width types:
	Largest 32-bit value is 4294967295 or 0xffffffff

[edit] 另请参见

将格式化的宽字符输出打印到stdout、文件流或缓冲区
(function) [edit]
将格式化的输出打印到 stdout、文件流或缓冲区
使用可变参数列表
(函数) [编辑]
将字符字符串写入文件流
(函数) [编辑]
stdin、文件流或缓冲区读取格式化的输入
(函数) [编辑]
(C++17)
将整数或浮点值转换为字符序列
(函数) [编辑]
(C++23)
使用 格式化 的参数表示形式,打印到 stdout 或文件流
(函数模板) [编辑]
(C++23)
std::print 相同,只是每次打印都以额外的换行符结尾
(函数模板) [编辑]
C 文档 for printf, fprintf, sprintf, snprintf