名稱空間
變體
操作

vprintf, vfprintf, vsprintf, vsnprintf, vprintf_s, vfprintf_s, vsprintf_s, vsnprintf_s

來自 cppreference.com
< c‎ | io
 
C
 
檔案輸入/輸出
型別和物件
        
函式
檔案訪問
(C11)
(C11)  
(C95)
非格式化輸入/輸出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)

格式化輸入
(C99)(C99)(C99)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)  
直接輸入/輸出
格式化輸出
vprintfvfprintfvsprintfvsnprintfvprintf_svfprintf_svsprintf_svsnprintf_s
(C99)(C11)(C11)(C11)(C11)
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
檔案定位
錯誤處理
檔案操作
 
定義於標頭檔案 <stdio.h>
(1)
int vprintf( const char* format, va_list vlist );
 (直到 C99)
int vprintf( const char* restrict format, va_list vlist );
 (C99 起)
(2)
int vfprintf( FILE* stream, const char* format, va_list vlist );
 (直到 C99)
int vfprintf( FILE* restrict stream, const char* restrict format,
              va_list vlist );
 (C99 起)
(3)
int vsprintf( char* buffer, const char* format, va_list vlist );
 (直到 C99)
int vsprintf( char* restrict buffer, const char* restrict format,
              va_list vlist );
 (C99 起)
int vsnprintf( char* restrict buffer, size_t bufsz,
               const char* restrict format, va_list vlist );
 (4) (C99 起)
int vprintf_s( const char* restrict format, va_list vlist );
 (5) (C11 起)
int vfprintf_s( FILE* restrict stream, const char* restrict format,
                va_list vlist );
 (6) (C11 起)
int vsprintf_s( char* restrict buffer, rsize_t bufsz,
                const char* restrict format, va_list vlist );
 (7) (C11 起)
int vsnprintf_s( char* restrict buffer, rsize_t bufsz,
                 const char* restrict format, va_list vlist );
 (8) (C11 起)

從 vlist 定義的位置載入資料，將其轉換為相應的字元字串，並將結果寫入各種目標。

1) 將結果寫入 stdout。
2) 將結果寫入檔案流 stream。
3) 將結果寫入字元字串 buffer。
4) 將結果寫入字元字串 buffer。最多寫入 bufsz - 1 個字元。除非 bufsz 為零，否則生成的字串將以空字元終止。如果 bufsz 為零，則不寫入任何內容，buffer 可以是空指標，但仍會計算並返回返回值（不包括空終止符的寫入位元組數）。
5-8) 與 (1-4) 相同，但以下錯誤會在執行時檢測到並呼叫當前安裝的約束處理函式：
  • format 中存在轉換說明符 %n
  • 任何對應於 %s 的引數都是空指標
  • format 或 buffer 是空指標
  • bufsz 為零或大於 RSIZE_MAX
  • 在任何字串和字元轉換說明符中發生編碼錯誤
  • (僅適用於 vsprintf_s)，要儲存在 buffer 中的字串（包括尾隨空字元）將超出 bufsz
與所有進行邊界檢查的函式一樣，只有在實現定義了 __STDC_LIB_EXT1__ 且使用者在包含 <stdio.h> 之前將 __STDC_WANT_LIB_EXT1__ 定義為整數常量 1 時，才能保證 vprintf_s、vfprintf_s、vsprintf_s 和 vsnprintf_s 可用。

目錄

[編輯] 引數

stream - 要寫入的輸出檔案流
buffer - 要寫入的字元字串指標
bufsz - 最多可寫入 bufsz - 1 個字元，外加空終止符
format - 指向以 null 結尾的字元字串的指標，指定如何解釋資料
vlist - 包含要列印的資料的可變引數列表。

format 字串由普通位元組字元（除了 %）組成，它們被不變地複製到輸出流中，以及轉換說明符。每個轉換說明符具有以下格式：

  • 前導 % 字元。
  • (可選) 一個或多個修改轉換行為的標誌
  • -: 轉換結果在欄位內左對齊（預設情況下右對齊）。
  • +: 有符號轉換的符號總是前置在轉換結果之前（預設情況下，結果只有在為負時才前置減號）。
  • 空格: 如果有符號轉換的結果不以符號字元開頭，或者為空，則在結果前置空格。如果存在 + 標誌，則忽略此標誌。
  • #: 執行轉換的替代形式。具體效果請參見下表，否則行為未定義。
  • 0：對於整數和浮點數轉換，使用前導零填充欄位而不是*空格*字元。對於整數，如果明確指定了精度，則忽略此標誌。對於使用此標誌的其他轉換，結果為未定義行為。如果存在 - 標誌，則忽略此標誌。
  • (可選) 整數值或 *，指定最小欄位寬度。如果需要，結果會用*空格*字元（預設）填充，右對齊時在左側，左對齊時在右側。當使用 * 時，寬度由一個額外的 int 型別引數指定，該引數出現在要轉換的引數之前，如果提供了精度引數，則出現在精度引數之前。如果引數值為負，則相當於指定了 - 標誌和正欄位寬度（注意：這是最小寬度：值永不截斷）。
  • (可選) . 後跟整數或 *，或兩者皆無，指定轉換的*精度*。當使用 * 時，*精度*由一個額外的 int 型別引數指定，該引數出現在要轉換的引數之前，但如果提供了最小欄位寬度引數，則出現在其之後。如果此引數值為負，則忽略它。如果既不使用數字也不使用 *，則精度取為零。請參閱下表瞭解*精度*的確切效果。
  • (可選) 長度修飾符，指定引數的大小（與轉換格式說明符結合使用，指定相應引數的型別）。
  • 轉換格式說明符。

以下格式說明符可用：

轉換
說明符		 解釋 預期
引數型別
長度修飾符→ hh h 無 l ll j z t L
僅在 C99 之後可用→ 是 是 是 是 是
% 寫入字面量 %。完整的轉換說明符必須是 %%。 不適用 不適用 不適用 不適用 不適用 不適用 不適用 不適用 不適用
c

寫入單個字元。

  • 引數首先轉換為 unsigned char。
  • 如果使用 l 修飾符，引數首先轉換為字串，就像使用 wchar_t[2] 引數的 %ls 一樣。
 不適用 不適用
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​，則轉換結果不包含任何字元。
  • 在替代實現中，如果轉換值非零，則在結果前新增 0x 或 0X。
 不適用
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 轉換樣式，將執行樣式 e 或 f 的轉換。
  • 對於 G 轉換樣式，將執行樣式 E 或 f(C99 前)F(C99 起) 的轉換。
  • 令 P 等於非零精度，如果未指定精度則為 6，如果精度為 ​0​ 則為 1。那麼，如果使用樣式 E 的轉換的指數為 X
    • 如果 P > X ≥ −4，則轉換樣式為 f 或 F(C99 起)，精度為 P − 1 − X。
    • 否則，轉換使用樣式 e 或 E，精度為 P − 1。
  • 除非請求替代表示，否則會刪除尾隨零，如果不再有小數部分，也會刪除小數點字元。
  • 關於無窮大和非數字的轉換樣式，請參見註釋。
 不適用 不適用 不適用 不適用 不適用 不適用
n

返回此函式呼叫目前已寫入的字元數。

  • 結果被寫入到引數指向的值。
  • 說明符不得包含任何標誌、欄位寬度或精度。
  • 對於 z 修飾符，預期的引數型別是 S*，其中 S 是 size_t 的有符號版本。
signed char*
short*
int*
long*
long long*
※
不適用
p

寫入一個實現定義的字元序列，定義一個指標。

 不適用 不適用
void*
 不適用 不適用 不適用 不適用 不適用 不適用
備註

浮點轉換函式將無窮大轉換為 inf 或 infinity。具體使用哪一個由實現定義。

非數字轉換為 nan 或 nan(char_sequence)。具體使用哪一個由實現定義。

轉換 F、E、G、A 輸出 INF、INFINITY、NAN。

用於列印 char、unsigned char、signed char、short 和 unsigned short 的轉換說明符期望 預設引數提升 的提升型別，但在列印其值之前，它將轉換為 char、unsigned char、signed char、short 和 unsigned short。由於呼叫可變引數函式時發生的提升，傳遞這些型別的值是安全的。

固定寬度字元型別（int8_t 等）的正確轉換規範定義在標頭檔案 <inttypes.h> 中（儘管 PRIdMAX、PRIuMAX 等與 %jd、%ju 等同義）。

記憶體寫入轉換說明符 %n 是安全漏洞的常見目標，其中格式字串依賴於使用者輸入，並且不受進行邊界檢查的 printf_s 函式家族支援(C11 起)。

每個轉換說明符的操作之後都有一個序列點；這允許在同一變數中儲存多個 %n 結果，或者，作為特殊情況，在同一呼叫中列印由早期 %n 修改的字串。

如果轉換說明符無效，則行為未定義。

[編輯] 返回值

1-3) 如果成功，寫入的字元數；如果發生錯誤，則為負值。
4) 如果成功，寫入的字元數；如果發生錯誤，則為負值。如果由於 buf_size 限制導致生成的字串被截斷，函式將返回將被寫入的總字元數（不包括終止空位元組），如果未施加限制的話。
5,6) 傳輸到輸出流的字元數；如果發生輸出錯誤、執行時約束違規錯誤或編碼錯誤，則為負值。
7) 寫入 buffer 的字元數，不包括空字元（只要 buffer 不是空指標且 bufsz 不為零且不大於 RSIZE_MAX，則總是寫入空字元），在執行時約束違規時為零，在編碼錯誤時為負值
8) 如果忽略 bufsz，將被寫入 buffer 的字元數，不包括終止空字元（只要 buffer 不是空指標且 bufsz 不為零且不大於 RSIZE_MAX，則總是寫入空字元），或者在執行時約束違規或編碼錯誤時為負值

[編輯] 注意

所有這些函式至少呼叫一次 va_arg，返回後 arg 的值是不確定的。這些函式不呼叫 va_end，這必須由呼叫者完成。

vsnprintf_s，與 vsprintf_s 不同，會將結果截斷以適應 buffer 指向的陣列。

Microsoft CRT 中 vsnprintf_s 的實現不符合 C 標準。Microsoft 的版本在第三個位置有一個額外的引數 size_t count，其中包含要寫入的最大字元數，不包括空終止符。此引數可能與透過引數 size_t bufsz 提供的緩衝區大小不同。

[編輯] 示例

執行此程式碼
#include <stdarg.h>
#include <stdio.h>
#include <time.h>
 
void debug_log(const char* fmt, ...)
{
    struct timespec ts;
    timespec_get(&ts, TIME_UTC);
    char time_buf[100];
    size_t rc = strftime(time_buf, sizeof time_buf, "%D %T", gmtime(&ts.tv_sec));
    snprintf(time_buf + rc, sizeof time_buf - rc, ".%06ld UTC", ts.tv_nsec / 1000);
 
    va_list args1;
    va_start(args1, fmt);
    va_list args2;
    va_copy(args2, args1);
    char buf[1+vsnprintf(NULL, 0, fmt, args1)];
    va_end(args1);
    vsnprintf(buf, sizeof buf, fmt, args2);
    va_end(args2);
 
    printf("%s [debug]: %s\n", time_buf, buf);
}
 
int main(void)
{
    debug_log("Logging, %d, %d, %d", 1, 2, 3);
}

可能的輸出

02/20/15 21:58:09.072683 UTC [debug]: Logging, 1, 2, 3

[編輯] 參考

  • C23 標準 (ISO/IEC 9899:2024)
  • 7.21.6.8 vfprintf 函式 (p: 待定)
  • 7.21.6.10 vprintf 函式 (p: 待定)
  • 7.21.6.12 vsnprintf 函式 (p: 待定)
  • 7.21.6.13 vsprintf 函式 (p: 待定)
  • K.3.5.3.8 vfprintf_s 函式 (p: 待定)
  • K.3.5.3.10 vprintf_s 函式 (p: 待定)
  • K.3.5.3.12 vsnprintf_s 函式 (p: 待定)
  • K.3.5.3.13 vsprintf_s 函式 (p: 待定)
  • C17 標準 (ISO/IEC 9899:2018)
  • 7.21.6.8 vfprintf 函式 (p: 238)
  • 7.21.6.10 vprintf 函式 (p: 239)
  • 7.21.6.12 vsnprintf 函式 (p: 239-240)
  • 7.21.6.13 vsprintf 函式 (p: 240)
  • K.3.5.3.8 vfprintf_s 函式 (p: 434)
  • K.3.5.3.10 vprintf_s 函式 (p: 435)
  • K.3.5.3.12 vsnprintf_s 函式 (p: 436-437)
  • K.3.5.3.13 vsprintf_s 函式 (p: 437)
  • C11 標準 (ISO/IEC 9899:2011)
  • 7.21.6.8 vfprintf 函式 (p: 326-327)
  • 7.21.6.10 vprintf 函式 (p: 328)
  • 7.21.6.12 vsnprintf 函式 (p: 329)
  • 7.21.6.13 vsprintf 函式 (p: 329)
  • K.3.5.3.8 vfprintf_s 函式 (p: 597)
  • K.3.5.3.10 vprintf_s 函式 (p: 598-599)
  • K.3.5.3.12 vsnprintf_s 函式 (p: 600)
  • K.3.5.3.13 vsprintf_s 函式 (p: 601)
  • C99 標準 (ISO/IEC 9899:1999)
  • 7.19.6.8 vfprintf 函式 (p: 292)
  • 7.19.6.10 vprintf 函式 (p: 293)
  • 7.19.6.12 vsnprintf 函式 (p: 294)
  • 7.19.6.13 vsprintf 函式 (p: 295)
  • C89/C90 標準 (ISO/IEC 9899:1990)
  • 4.9.6.7 vfprintf 函式
  • 4.9.6.8 vprintf 函式
  • 4.9.6.9 vsprintf 函式

[編輯] 參見

(C95)(C95)(C95)(C11)(C11)(C11)(C11)
 將格式化的寬字元輸出列印到 stdout、檔案流
或使用可變引數列表的緩衝區
(函式) [編輯]
(C99)(C11)(C11)(C11)(C11)
 將格式化輸出列印到 stdout、檔案流或緩衝區
(函式) [編輯]
(C99)(C99)(C99)(C11)(C11)(C11)
 從 stdin、檔案流或緩衝區讀取格式化輸入
使用可變引數列表
(函式) [編輯]
C++ 文件，關於 vprintf, vfprintf, vsprintf, vsnprintf
取自 "https://cppreference.tw/mwiki/index.php?title=c/io/vfprintf&oldid=172068"