名稱空間
變體
操作

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

來自 cppreference.com
< 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