命名空间
变体
操作

printf, fprintf, sprintf, snprintf, printf_s, fprintf_s, sprintf_s, snprintf_s

来自 cppreference.cn
< c‎ | io
 
 
文件输入/输出
类型和对象
        
函数
文件访问
(C95)
非格式化输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)

格式化输入
直接输入/输出
格式化输出
printffprintfsprintfsnprintfprintf_sfprintf_ssprintf_ssnprintf_s
(C99)(C11)(C11)(C11)(C11)
文件定位
错误处理
文件操作
 
定义于头文件 <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, size_t 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) 相同,但会在运行时检测以下错误并调用当前安装的 约束处理器 函数
  • format 中存在转换说明符 %n
  • 任何对应于 %s 的参数都是空指针
  • streamformatbuffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX
  • 在任何字符串和字符转换说明符中发生编码错误
  • (仅适用于 sprintf_s),要存储在 buffer 中的字符串(包括尾随空字符)将超出 bufsz
与所有进行边界检查的函数一样,只有当实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时,才能保证 printf_s, fprintf_s, sprintf_ssnprintf_s 可用。

目录

[编辑] 参数

stream - 要写入的输出文件流
buffer - 要写入的字符字符串指针
bufsz - 最多可写入 bufsz - 1 个字符,外加空终止符
format - 指向空终止字节字符串的指针,指定如何解释数据
... - 指定要打印数据的参数。如果在默认参数提升后,任何参数的类型与相应转换规范期望的类型不符(期望类型为提升后的类型或提升后类型的兼容类型),或者参数数量少于 format 所需,则行为未定义。如果参数数量多于 format 所需,则多余的参数会被评估并忽略。

format 字符串由普通字节字符(除了 %)组成,它们被不变地复制到输出流中,以及转换说明符。每个转换说明符具有以下格式:

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

以下格式说明符可用:

转换
说明符
解释 预期
参数类型
长度修饰符→ hh h l ll j z t L
仅在 C99 之后可用→
% 写入字面量 %。完整的转换说明符必须是 %% 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

写入单个字符

  • 参数首先转换为 unsigned char
  • 如果使用 l 修饰符,参数首先转换为字符串,如同通过 %lswchar_t[2] 参数转换一样。
不适用 不适用
int
wint_t
不适用 不适用 不适用 不适用 不适用
s

写入字符字符串

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

有符号整数转换为十进制表示 [-]dddd

  • 精度指定要出现的最小位数。默认精度为 1
  • 如果转换值和精度都为 0,则转换结果不包含任何字符。
  • 对于 z 修饰符,预期参数类型是 size_t 的有符号版本。
signed char
short
int
long
long long
不适用
o

无符号整数转换为八进制表示 oooo

  • 精度指定要出现的最小位数。默认精度为 1
  • 如果转换值和精度都为 0,则转换结果不包含任何字符。
  • 在*替代实现*中,如果需要,会增加精度以写入一个前导零。在这种情况下,如果转换值和精度都为 0,则写入单个 0
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t 的无符号版本
不适用
x
X

无符号整数转换为十六进制表示 hhhh

  • 对于 x 转换,使用字母 abcdef
  • 对于 X 转换,使用字母 ABCDEF
  • 精度指定要出现的最小位数。默认精度为 1
  • 如果转换值和精度都为 0,则转换结果不包含任何字符。
  • 替代实现中,如果转换值非零,则在结果前添加 0x0X
不适用
u

无符号整数转换为十进制表示 dddd

  • 精度 指定要出现的最小位数。
  • 默认精度为 1
  • 如果转换值和精度都为 0,则转换结果不包含任何字符。
不适用
f
F (C99)

浮点数转换为十进制表示法,样式为 [-]ddd.ddd

  • 精度 指定小数点字符后要出现的准确位数。
  • 默认精度为 6
  • 替代实现中,即使后面没有数字,也会写入小数点字符。
  • 关于无穷大和非数字的转换样式,请参见注释
不适用 不适用
double
double (C99)
不适用 不适用 不适用 不适用
long double
e
E

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

  • 对于 e 转换,使用样式 [-]d.ddd e±dd
  • 对于 E 转换,使用样式 [-]d.ddd E±dd
  • 指数至少包含两位数字,只有在必要时才使用更多数字。
  • 如果值为 0,则指数也为 0
  • 精度 指定小数点字符后要出现的准确位数。
  • 默认精度为 6
  • 替代实现中,即使后面没有数字,也会写入小数点字符。
  • 关于无穷大和非数字的转换样式,请参见注释
不适用 不适用 不适用 不适用 不适用 不适用
a
A

(C99)

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

  • 对于 a 转换,使用样式 [-] 0xh.hhh p±d
  • 对于 A 转换,使用样式 [-] 0Xh.hhh P±d
  • 如果参数是规范化浮点值,则第一个十六进制数字不是 0
  • 如果值为 0,则指数也为 0
  • 精度 指定十六进制小数点字符后要出现的准确位数。
  • 默认精度足以精确表示该值。
  • 替代实现中,即使后面没有数字,也会写入小数点字符。
  • 关于无穷大和非数字的转换样式,请参见注释
不适用 不适用 不适用 不适用 不适用 不适用
g
G

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

  • 对于 g 转换样式,将执行样式 ef 的转换。
  • 对于 G 转换样式,将执行样式为 Ef(直到 C99)F(C99 起) 的转换。
  • P 等于精度(如果非零),如果未指定精度,则为 6,如果精度为 0,则为 1。然后,如果使用样式 E 的转换将具有指数 X
    • 如果 P > X ≥ −4,则转换样式为 fF(C99 起),精度为 P − 1 − X
    • 否则,转换使用样式 eE,精度为 P − 1
  • 除非请求替代表示,否则会删除尾随零,如果不再有小数部分,也会删除小数点字符。
  • 关于无穷大和非数字的转换样式,请参见注释
不适用 不适用 不适用 不适用 不适用 不适用
n

返回此函数调用目前已写入的字符数

  • 结果被写入到参数指向的值。
  • 说明符不得包含任何标志字段宽度精度
  • 对于 z 修饰符,预期的参数类型是 S*,其中 Ssize_t 的有符号版本。
signed char*
short*
int*
long*
long long*
不适用
p

写入一个实现定义的字符序列,定义一个指针

不适用 不适用
void*
不适用 不适用 不适用 不适用 不适用 不适用
备注

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

非数字转换为 nannan(char_sequence)。具体使用哪一个由实现定义。

转换 FEGA 输出 INFINFINITYNAN

用于打印 char, unsigned char, signed char, shortunsigned short 的转换说明符期望 默认参数提升 后的提升类型,但在打印其值之前,会将其转换为 char, unsigned char, signed char, shortunsigned short。由于在调用可变参数函数时会发生提升,因此安全地传递这些类型的值。

定宽字符类型(int8_t 等)的正确转换说明符在头文件 <inttypes.h> 中定义(尽管 PRIdMAX, PRIuMAX 等与 %jd, %ju 等同义)。

内存写入转换说明符 %n 是格式字符串依赖用户输入时常见的安全漏洞目标,并且不受进行边界检查的 printf_s 函数家族支持(C11 起)

每个转换说明符的操作之后都有一个序列点;这允许在同一变量中存储多个 %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); // <- broken: undefined behavior

POSIX 规定errno 在出错时设置。它还规定了额外的转换说明符,最值得注意的是支持参数重排序(n$ 紧接在 % 之后表示第 n 个参数)。

调用 snprintf,将 bufsz 设置为零,将 buffer 设置为空指针,可用于确定容纳输出所需的缓冲区大小。

const char fmt[] = "sqrt(2) = %f";
int sz = snprintf(NULL, 0, fmt, sqrt(2));
char buf[sz + 1]; // note +1 for terminating null byte
snprintf(buf, sizeof buf, fmt, sqrt(2));

snprintf_s,就像 snprintf 一样,但与 sprintf_s 不同,会将输出截断以适应 bufsz - 1

[编辑] 示例

#include <inttypes.h>
#include <stdint.h>
#include <stdio.h>
 
int main(void)
{
    const char* s = "Hello";
    printf("Strings:\n"); // same as puts("Strings");
    printf(" padding:\n");
    printf("\t[%10s]\n", s);
    printf("\t[%-10s]\n", s);
    printf("\t[%*s]\n", 10, s);
    printf(" truncating:\n");
    printf("\t%.4s\n", s);
    printf("\t%.*s\n", 3, s);
 
    printf("Characters:\t%c %%\n", 'A');
 
    printf("Integers:\n");
    printf("\tDecimal:\t%i %d %.6i %i %.0i %+i %i\n",
                         1, 2,   3, 0,   0,  4,-4);
    printf("\tHexadecimal:\t%x %x %X %#x\n", 5, 10, 10, 6);
    printf("\tOctal:\t\t%o %#o %#o\n", 10, 10, 4);
 
    printf("Floating-point:\n");
    printf("\tRounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3);
    printf("\tPadding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    printf("\tScientific:\t%E %e\n", 1.5, 1.5);
    printf("\tHexadecimal:\t%a %A\n", 1.5, 1.5);
    printf("\tSpecial values:\t0/0=%g 1/0=%g\n", 0.0 / 0.0, 1.0 / 0.0);
 
    printf("Fixed-width types:\n");
    printf("\tLargest 32-bit value is %" PRIu32 " or %#" PRIx32 "\n",
                                     UINT32_MAX,     UINT32_MAX );
}

可能的输出

Strings:
 padding:
        [     Hello]
        [Hello     ]
        [     Hello]
 truncating:
        Hell
        Hel
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
Fixed-width types:
        Largest 32-bit value is 4294967295 or 0xffffffff

[编辑] 参考文献

  • C23 标准 (ISO/IEC 9899:2024)
  • 7.21.6.1 fprintf 函数 (p: TBD)
  • 7.21.6.3 printf 函数 (p: TBD)
  • 7.21.6.5 snprintf 函数 (p: TBD)
  • 7.21.6.6 sprintf 函数 (p: TBD)
  • K.3.5.3.1 fprintf_s 函数 (p: TBD)
  • K.3.5.3.3 printf_s 函数 (p: TBD)
  • K.3.5.3.5 snprintf_s 函数 (p: TBD)
  • K.3.5.3.6 sprintf_s 函数 (p: TBD)
  • C17 标准 (ISO/IEC 9899:2018)
  • 7.21.6.1 fprintf 函数 (p: 225-230)
  • 7.21.6.3 printf 函数 (p: 236)
  • 7.21.6.5 snprintf 函数 (p: 237)
  • 7.21.6.6 sprintf 函数 (p: 237)
  • K.3.5.3.1 fprintf_s 函数 (p: 430)
  • K.3.5.3.3 printf_s 函数 (p: 432)
  • K.3.5.3.5 snprintf_s 函数 (p: 432-433)
  • K.3.5.3.6 sprintf_s 函数 (p: 433)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.21.6.1 fprintf 函数 (p: 309-316)
  • 7.21.6.3 printf 函数 (p: 324)
  • 7.21.6.5 snprintf 函数 (p: 325)
  • 7.21.6.6 sprintf 函数 (p: 325-326)
  • K.3.5.3.1 fprintf_s 函数 (p: 591)
  • K.3.5.3.3 printf_s 函数 (p: 593-594)
  • K.3.5.3.5 snprintf_s 函数 (p: 594-595)
  • K.3.5.3.6 sprintf_s 函数 (p: 595-596)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.19.6.1 fprintf 函数 (p: 274-282)
  • 7.19.6.3 printf 函数 (p: 290)
  • 7.19.6.5 snprintf 函数 (p: 290-291)
  • 7.19.6.6 sprintf 函数 (p: 291)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 4.9.6.1 fprintf 函数
  • 4.9.6.3 printf 函数
  • 4.9.6.5 sprintf 函数

[编辑] 另请参阅

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