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

来自cppreference.com
< cpp‎ | io‎ | c
 
 
 
C 风格 I/O
类型与对象
函数
文件访问
直接输入/输出
无格式输入/输出
有格式输入
有格式输出
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 - 指向指定如何转译数据的空终止多字节字符串的指针。

格式字符串由普通多字节字符(除了 % )和转换指定构成,前者被复制到输出流而无更改。每个转换指定拥有下列格式:

  • 引入的 % 字符
  • (可选)一或多个修改转换行为的标签:
  • - :转换结果在域内左校正(默认为右校正)
  • + :有符号转换的符号始终前置于转换结果(默认结果前置负号仅当它为负)
  • 空格:若有符号转换的结果不以符号开始,或为空,则前置空格于结果。若存在 + 标签则忽略空格
  • # :进行替用形式的转换。准确的效果见下表,其他情况下行为未定义。
  • 0 :对于整数和浮点数转换,使用前导零代替空格字符填充域。对于整数,若显式指定精度,则忽略此标签。对于其他转换,使用此标签导致未定义行为。若存在 - 标签则忽略 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 修饰符,则参数首先被转换成字符串,如同通过以 wchar_t[2] 参数使用 %ls

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

参数必须是指向字符数组首元素的指针 精度指定写入最大的字符数。若未指定精度,则写每个字节直到而不含首个空终止符。 若使用 l 指定符,则参数必须是指向 wchar_t 数组首元素的指针,数组会被转换成 char 数组,如同通过以零初始化转换状态调用 wcrtomb

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
有符号 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*
有符号 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 。使用哪个是实现定义的。

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

转换 FEGA 替代上面输出 INFINFINITYNAN

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

定宽整数类型( int8_t 等)的正确转换指定定义于头文件 <cinttypes> (尽管 PRIdMAXPRIuMAX 等就是 %jd%ju 等的别名)。

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

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

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


... - 指定要打印数据的参数。若任何参数类型不是对应转换指定符所期望者,或若参数数量少于 format 所要求这,则行为未定义。若参数数量多于 format 所要求者,则求值后忽略额外参数

返回值

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

注意

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

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

const char *fmt = "sqrt(2) = %f";
int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2));
std::vector<char> buf(sz + 1); // 注意为空终止符 +1
std::snprintf(&buf[0], buf.size(), fmt, std::sqrt(2));

示例

#include <cstdio>
#include <limits>
#include <cstdint>
#include <cinttypes>
 
int main()
{
    std::printf("Strings:\n");
 
    const char* s = "Hello";
    std::printf("\t[%10s]\n\t[%-10s]\n\t[%*s]\n\t[%-10.*s]\n\t[%-*.*s]\n",
        s, s, 10, s, 4, s, 10, 4, s);
 
    std::printf("Characters:\t%c %%\n", 65);
 
    std::printf("Integers\n");
    std::printf("Decimal:\t%i %d %.6i %i %.0i %+i %u\n", 1, 2, 3, 0, 0, 4, -1);
    std::printf("Hexadecimal:\t%x %x %X %#x\n", 5, 10, 10, 6);
    std::printf("Octal:\t%o %#o %#o\n", 10, 10, 4);
 
    std::printf("Floating point\n");
    std::printf("Rounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.5);
    std::printf("Padding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    std::printf("Scientific:\t%E %e\n", 1.5, 1.5);
    std::printf("Hexadecimal:\t%a %A\n", 1.5, 1.5);
    std::printf("Special values:\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0);
 
    std::printf("Variable width control:\n");
    std::printf("right-justified variable width: '%*c'\n", 5, 'x');
    int r = std::printf("left-justified variable width : '%*c'\n", -5, 'x');
    std::printf("(the last printf printed %d characters)\n", r);
 
    // 定宽类型
    std::uint32_t val = std::numeric_limits<std::uint32_t>::max();
    std::printf("Largest 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 4294967295
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 40 characters)
Largest 32-bit value is 4294967295 or 0xffffffff

参阅

打印有格式宽字符输出到 stdout、文件流或缓冲区
(函数)
使用可变实参列表
打印有格式输出到 stdout、文件流或缓冲区
(函数)
写字符串到文件流
(函数)
stdin、文件流或缓冲区读取有格式输入
(函数)
(C++17)
转换整数或浮点值到字符序列
(函数)