printf, fprintf, sprintf, snprintf, printf_s, fprintf_s

来自cppreference.com
< c‎ | io
定义于头文件 <stdio.h>
(1)
int printf( const char *format, ... );
(C99 前)
int printf( const char *restrict format, ... );
(C99 起)
(2)
int fprintf( FILE *stream, const char *format, ... );
(C99 前)
int fprintf( FILE *restrict stream, const char *restrict format, ... );
(C99 起)
(3)
int sprintf( char *buffer, const char *format, ... );
(C99 前)
int sprintf( char *restrict buffer, const char *restrict format, ... );
(C99 起)
int snprintf( char *restrict buffer, int bufsz,
              const char *restrict format, ... );
(4) (C99 起)
int printf_s(const char *restrict format, ...);
(5) (C11 起)
int fprintf_s(FILE *restrict stream, const char *restrict format, ...);
(6) (C11 起)
int sprintf_s(char *restrict buffer, rsize_t bufsz,
              const char *restrict format, ...);
(7) (C11 起)
int snprintf_s(char *restrict buffer, rsize_t bufsz,
               const char *restrict format, ...);
(8) (C11 起)

从给定位置加载数据,将它们转换成字符串等价物并将结果写入各种池中。

1) 写结果到输出流stdout
2) 写结果到输出流stream
3) 写结果到字符串buffer。若被写入的字符串(加上空终止字符)长度超出buffer所指向的数组大小则行为未定义。
4) 写结果到字符串buffer。至多写bufsz - 1个字符。结果字符串会以空终止符终止,除非bufsz是零。若bufsz为零,则不写入任何内容且buffer可以是空指针,然而返回值(会被写入的字节数)被照样计算并返回。
5-8)(1-4),除了在运行时检测下列错误并调用当前安装的强制处理函数:
  • 转换指定符%n存在于format
  • 任何一个对应%s的参数是空指针
  • formatbuffer是空指针
  • bufsz为零或大于RSIZE_MAX
  • 在任何一个字符串及字符转换指定符中出现编码错误
  • (仅对于sprintf_s)存储于buffer的字符串(包括尾随空字符)长度将超出bufsz
同所有边界检查函数,仅若实现定义了__STDC_LIB_EXT1__且用户在包含前<stdio.h>定义__STDC_WANT_LIB_EXT1__为整数常量1,才保证printf_sfprintf_ssprintf_ssnrintf_s可用。

目录

[编辑] 参数

stream - 要写入的输出文件流
buffer - 指向要写入的字符串的指针
bufsz - 最多会写入bufsz - 1个字符,再加空终止符
format - 指向指定数据转译方式的空终止多字节字符串的指针。

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

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

下列格式指定符可用:

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

(C99)

h (无) l ll

(C99)

j

(C99)

z

(C99)

t

(C99)

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
有符号size_t
N/A
o
转换一个无符号整数到八进制表示oooo

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

unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
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 (C99)
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

(C99)

转换一个浮点数为十六进制记号。

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*
signed size_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等)的正确转换指定定义于头文件<inttypes.h>(尽管PRIdMAXPRIuMAX等就是%jd%ju等的别名)。

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

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

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


... - 指定要打印数据的参数

[编辑] 返回值

1,2) 传输到输出流的字符数,或若输出错误或编码错误(对于字符串和字符转换指定符)发生则为负值。
3) 写入到buffer的字符数(不计空终止字符),或若输出错误或编码错误(对于字符串和字符转换指定符)发生则为负值。
4) 假如忽略了bufsz的本应写入到buffer的字符数(不计空终止字符),或若输出错误或编码错误(对于字符串和字符转换指定符)发生则为负值。
5,6) 传输到输出流的字符数,或若输出错误、运行时强制违规错误或编码错误发生则为负值。
7) 写入到buffer的字符数,不计空终止字符(只要buffer不是空指针且bufsz非零且不大于RSIZE_MAX,它就会被写入),在运行时强制违规时为零,而在编码错误时为负值。
8) 假如忽略了bufsz的本应本应写入到buffer的字符数的字符数,不包含空终止字符(只要buffer不是空指针且bufsz非零且不大于RSIZE_MAX,它就会被写入),或若输出错误、运行时强制违规错误或编码错误发生则为负值。

[编辑] 注意

C标准及POSIX指定sprintf及其变体的行为在参数与目标缓冲区重叠时未定义。示例:

sprintf(dst, "%s and %s", dst, t); // <- 有错:未定义行为

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

以零为bufsz和空指针为buffer调用snprintf可用于决定包含输出的缓冲区大小:

const char *fmt = "sqrt(2) = %f";
int sz = snprintf(NULL, 0, fmt, sqrt(2));
char buf[sz + 1]; // 注意为终止空字符+1
snprintf(buf, sizeof buf, fmt, sqrt(2));

如同snprintf,但不同于sprintf_ssnprintf_s会将输出截断在bufsz-1之内。

[编辑] 示例

#include <stdio.h>
 
int main(void)
{
    printf("Strings:\n");
    const char* s = "Hello";
    printf("\t.%10s.\n\t.%-10s.\n\t.%*s.\n", s, s, 10, s);
 
    printf("Characters:\t%c %%\n", 65);
 
    printf("Integers\n");
    printf("Decimal:\t%i %d %.6i %i %.0i %+i %u\n", 1, 2, 3, 0, 0, 4, -1);
    printf("Hexadecimal:\t%x %x %X %#x\n", 5, 10, 10, 6);
    printf("Octal:\t%o %#o %#o\n", 10, 10, 4);
 
    printf("Floating point\n");
    printf("Rounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3);
    printf("Padding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    printf("Scientific:\t%E %e\n", 1.5, 1.5);
    printf("Hexadecimal:\t%a %A\n", 1.5, 1.5);
}

输出:

Strings:
    .     Hello.
    .Hello     .
    .     Hello.
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

[编辑] 参考

  • C11 standard (ISO/IEC 9899:2011):
  • 7.21.6.1 The fprintf function (p: 309-316)
  • 7.21.6.3 The printf function (p: 324)
  • 7.21.6.5 The snprintf function (p: 325)
  • 7.21.6.6 The sprintf function (p: 325-326)
  • K.3.5.3.1 The fprintf_s function (p: 591)
  • K.3.5.3.3 The printf_s function (p: 593-594)
  • K.3.5.3.5 The snprintf_s function (p: 594-595)
  • K.3.5.3.6 The sprintf_s function (p: 595-596)
  • C99 standard (ISO/IEC 9899:1999):
  • 7.19.6.1 The fprintf function (p: 274-282)
  • 7.19.6.3 The printf function (p: 290)
  • 7.19.6.5 The snprintf function (p: 290-291)
  • 7.19.6.6 The sprintf function (p: 291)
  • C89/C90 standard (ISO/IEC 9899:1990):
  • 4.9.6.1 The fprintf function
  • 4.9.6.3 The printf function
  • 4.9.6.5 The sprintf function

[编辑] 参阅

打印格式化宽字符输出到stdout、文件流或缓冲区
(函数) [edit]
打印格式化输出到stdout、文件流或缓冲区
使用可变参数列表
(函数) [edit]
将一个字符串写入文件流
(函数) [edit]
stdin、文件流或缓冲区读取格式化输入
(函数) [edit]
printf, fprintf, sprintf, snprintfC++文档