Namespaces
Variants

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

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Direct input/output
Formatted output
printf fprintf sprintf snprintf printf_s fprintf_s sprintf_s snprintf_s
(C99) (C11) (C11) (C11) (C11)
(C95) (C95) (C95) (C11) (C11) (C11) (C11)
File positioning
Error handling
Operations on files
定义于头文件 <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) 相同，但在运行时检测到以下错误时会调用当前安装的 约束处理函数 ：
  • 转换说明符 %n 出现在 format 中
  • 对应 %s 的任何参数是空指针
  • stream 或 format 或 buffer 是空指针
  • bufsz 为零或大于 RSIZE_MAX
  • 在任何字符串和字符转换说明符中出现编码错误
  • （仅限 sprintf_s ）要存储到 buffer 中的字符串（包括结尾空字符）将超过 bufsz
与所有边界检查函数一样，只有在实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整型常量 1 时，才保证 printf_s 、 fprintf_s 、 sprintf_s 和 snprintf_s 可用。

目录

参数

stream - 用于写入的输出文件流
buffer - 指向要写入的字符串的指针
bufsz - 最多可写入 bufsz - 1 个字符，外加空终止符
format - 指向空终止字节字符串的指针，指定如何解析数据
... - 指定要打印数据的参数。若经 默认参数提升 后的任何参数不符合对应转换说明符期望的类型（期望类型为提升后的类型或与提升类型兼容的类型），或参数数量少于 format 所需数量，则行为未定义。若参数数量多于 format 所需数量，多余参数会被求值并忽略。

format 字符串由普通字节字符（除 % 外）和转换说明组成，前者会原样复制到输出流中。每个转换说明具有以下格式：

  • 开头的 % 字符。
  • (可选) 一个或多个用于修改转换行为的标志：
  • - ：转换结果在字段内左对齐（默认为右对齐）。
  • + ：有符号转换的符号始终预置于转换结果前（默认仅当结果为负数时前置负号）。
  • space ：若有符号转换结果不以符号字符开头或为空时，将在结果前添加空格。若存在 + 标志则此标志被忽略。
  • # ：执行转换的 替代形式 。具体效果参见下表，否则行为未定义。
  • 0 ：对于整数和浮点数转换，使用前导零而非 空格 字符填充字段。对于整数，若已显式指定精度则忽略此标志。其他转换使用此标志将导致未定义行为。若存在 - 标志则此标志被忽略。
  • (可选) 整数值或 * ，用于指定最小字段宽度。需要时默认使用 空格 字符填充结果：右对齐时在左侧填充，左对齐时在右侧填充。若使用 * ，宽度由类型为 int 的附加参数指定，该参数位于待转换参数之前（若提供了精度参数，则位于精度参数之前）。若参数值为负数，将等效于指定 - 标志并采用正数字段宽度（注意：此为最小宽度：值永远不会被截断）。
  • (可选) . 后接整数数字或 * ，或两者皆不指定，用于定义转换的 精度 。当使用 * 时， 精度 由类型为 int 的附加参数指定，该参数出现在待转换参数之前，但如果提供了最小字段宽度参数，则在其之后。若此参数值为负数，则被忽略。若未使用数字或 * ，则精度视为零。具体 精度 的影响请参阅下表。
  • (可选) 长度修饰符 ，用于指定参数的大小（与转换格式说明符结合使用时，可指定对应参数的类型）。
  • 转换格式说明符。

以下格式说明符可用：

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

写入 单个字符 。

  • 参数首先转换为 unsigned char 。
  • 若使用 l 修饰符，参数首先转换为字符串，如同通过 %ls 以 wchar_t [ 2 ] 参数进行转换。
不适用 不适用
int
wint_t
不适用 不适用 不适用 不适用 不适用
s

写入 字符串 。

  • 参数必须是指向字符数组首元素的指针。
  • 精度 指定要写入的最大字节数。若未指定 精度 ，则写入直到第一个空终止符之前的所有字节。
  • 若使用 l 说明符，参数必须是指向 wchar_t 数组首元素的指针，该数组会通过调用 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 ​ ，则转换不产生任何字符。
  • 在 替代实现 中，若转换后的值非零，则结果前缀 0x 或 0X 。
不适用
u

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

  • 精度 指定要出现的最小位数。
  • 默认精度为 1 。
  • 若转换后的值和精度均为 ​ 0 ​ ，则转换不产生任何字符。
不适用
f
F (C99)

将 浮点数 转换为样式为 [-]ddd.ddd 的十进制表示。

  • 精度 指定小数点后要出现的精确位数。
  • 默认精度为 6 。
  • 在 替代实现 中，

返回值

1,2) 传输到输出流的字符数量，若出现输出错误或编码错误（针对字符串和字符转换说明符）则返回负值。
3) 写入到 buffer 的字符数量（不包含终止空字符），若出现编码错误（针对字符串和字符转换说明符）则返回负值。
4) 应写入 buffer 的字符数量（不包含终止空字符），若忽略 bufsz 参数时的返回值；若发生编码错误（针对字符串和字符转换说明符）则返回负值。
5,6) 传输到输出流的字符数量，若出现输出错误、运行时约束违反错误或编码错误则返回负值。
7) 写入到 buffer 的字符数量（不计算空字符，只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX ，空字符就始终会被写入），在运行时约束违规时返回零，在编码错误时返回负值。
8) 不包含终止空字符的字符数量（只要 buffer 不是空指针且 bufsz 不为零且不大于 RSIZE_MAX 时始终会写入），该数值是在忽略 bufsz 的情况下本应写入 buffer 的字符数，若发生运行时约束违规或编码错误则返回负值。

注释

C 标准和 POSIX 规定，当参数与目标缓冲区重叠时， sprintf 及其变体的行为是未定义的。示例： 

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

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]; // 注意：+1 用于存放终止空字节
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 );
}

可能的输出： 

字符串：
 填充：
        [     Hello]
        [Hello     ]
        [     Hello]
 截断：
        Hell
        Hel
字符：         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
定宽类型：
        最大的32位值是 4294967295 或 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 函数 (页: 225-230)
  • 7.21.6.3 printf 函数 (页: 236)
  • 7.21.6.5 snprintf 函数 (页: 237)
  • 7.21.6.6 sprintf 函数 (页: 237)
  • K.3.5.3.1 fprintf_s 函数 (页: 430)
  • K.3.5.3.3 printf_s 函数 (页: 432)
  • K.3.5.3.5 snprintf_s 函数 (页: 432-433)
  • K.3.5.3.6 sprintf_s 函数 (页: 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函数（页码：274-282）
  • 7.19.6.3 printf函数（页码：290）
  • 7.19.6.5 snprintf函数（页码：290-291）
  • 7.19.6.6 sprintf函数（页码：291）
  • C89/C90 标准 (ISO/IEC 9899:1990):
  • 4.9.6.1 fprintf 函数
  • 4.9.6.3 printf 函数
  • 4.9.6.5 sprintf 函数

参见

(C95) (C95) (C95) (C11) (C11) (C11) (C11)
将格式化宽字符输出打印到 stdout 、文件流或缓冲区
(函数)
(C99) (C11) (C11) (C11) (C11)
使用可变参数列表将格式化输出打印到 stdout 、文件流或缓冲区

(函数)
将字符串写入文件流
(函数)
(C11) (C11) (C11)
从 stdin 、文件流或缓冲区读取格式化输入
(函数)
C++ 文档 关于 printf , fprintf , sprintf , snprintf