名稱空間
變體
操作

std::vprintf, std::vfprintf, std::vsprintf, std::vsnprintf

來自 cppreference.com
< cpp‎ | io‎ | c
 
C++
 
輸入/輸出庫
 
C 風格 I/O
型別和物件
函式
檔案訪問
直接輸入/輸出
非格式化輸入/輸出
格式化輸入
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
格式化輸出
(C++11)
vprintfvfprintfvsprintfvsnprintf
(C++11)    
檔案定位
錯誤處理
檔案操作
 
定義於標頭檔案 <cstdio>
int vprintf( const char* format, std::va_list vlist );
 (1)
int vfprintf( std::FILE* stream, const char* format, std::va_list vlist );
 (2)
int vsprintf( char* buffer, const char* format, std::va_list vlist );
 (3)
int vsnprintf( char* buffer, std::size_t buf_size, const char* format, std::va_list vlist );
 (4) (C++11 起)

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

1) 將結果寫入 stdout。
2) 將結果寫入檔案流 stream。
3) 將結果寫入字元字串 buffer。
4) 將結果寫入字元字串 buffer。最多寫入 buf_size - 1 個字元。除非 buf_size 為零，否則結果字元字串將以空字元終止。如果 buf_size 為零，則不寫入任何內容，且 buffer 可能為空指標，但仍會計算並返回返回值（不包括空終止符，將寫入的位元組數）。

目錄

[編輯] 引數

stream - 要寫入的輸出檔案流
buffer - 要寫入的字元字串指標
buf_size - 要寫入的最大字元數
format - 指向一個空終止字元字串的指標，指定如何解釋資料
vlist - 包含要列印資料的可變引數列表

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

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

以下格式說明符可用：

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

寫入單個字元。

  • 引數首先轉換為 unsigned char。
  • 如果使用 l 修飾符，引數首先轉換為字元字串，就像使用 wchar_t[2] 引數透過 %ls 轉換一樣。
 不適用 不適用
int
std::wint_t
 不適用 不適用 不適用 不適用 不適用
s

寫入字元字串。

  • 引數必須是指向字元陣列初始元素的指標。
  • 精度 指定要寫入的最大位元組數。如果未指定精度，則寫入每個位元組直到（但不包括）第一個空終止符。
  • 如果使用 l 說明符，引數必須是指向 wchar_t 陣列初始元素的指標，該陣列透過呼叫 std::wcrtomb 並使用零初始化的轉換狀態轉換為 char 陣列。
 不適用 不適用
char*
wchar_t*
 不適用 不適用 不適用 不適用 不適用
d
i

將有符號整數轉換為十進位制表示 [-]dddd。

  • 精度 指定要出現的最小位數。預設精度為 1。
  • 如果轉換值和精度都為 ​0​，則轉換結果為空字元。
  • 對於 z 修飾符，期望的引數型別是 std::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
std::ptrdiff_t 的無符號版本
 不適用
x
X

將無符號整數轉換為十六進位制表示 hhhh。

  • 對於 x 轉換，使用字母 abcdef。
  • 對於 X 轉換，使用字母 ABCDEF。
  • 精度 指定要出現的最小位數。預設精度為 1。
  • 如果轉換值和精度都為 ​0​，則轉換結果為空字元。
  • 在替代實現中，如果轉換值非零，則在結果前新增 0x 或 0X。
 不適用
u

將無符號整數轉換為十進位制表示 dddd。

  • 精度 指定要出現的最小位數。
  • 預設精度為 1。
  • 如果轉換值和精度都為 ​0​，則轉換結果為空字元。
 不適用
f
F (C++11起)

將浮點數轉換為十進位制表示法，樣式為 [-]ddd.ddd。

  • 精度 指定小數點字元後要出現的準確位數。
  • 預設精度為 6。
  • 在替代實現中，即使後面沒有數字，也會寫入小數點字元。
  • 關於無窮大和非數字的轉換樣式，請參見註釋。
 不適用 不適用
double
double (C++11起)
 不適用 不適用 不適用 不適用
long double
e
E

將浮點數轉換為十進位制指數表示法。

  • 對於 e 轉換，使用樣式 [-]d.ddd e±dd。
  • 對於 E 轉換，使用樣式 [-]d.ddd E±dd。
  • 指數至少包含兩位數字，只有在必要時才使用更多數字。
  • 如果值為 ​0​，則指數也為 ​0​。
  • 精度 指定小數點字元後要出現的準確位數。
  • 預設精度為 6。
  • 在替代實現中，即使後面沒有數字，也會寫入小數點字元。
  • 關於無窮大和非數字的轉換樣式，請參見註釋。
 不適用 不適用 不適用 不適用 不適用 不適用
a
A

(C++11)

將浮點數轉換為十六進位制指數表示法。

  • 對於 a 轉換，使用樣式 [-] 0xh.hhh p±d。
  • 對於 A 轉換，使用樣式 [-] 0Xh.hhh P±d。
  • 如果引數是規範化浮點值，則第一個十六進位制數字不是 0。
  • 如果值為 ​0​，則指數也為 ​0​。
  • 精度 指定十六進位制小數點字元後要出現的準確位數。
  • 預設精度足以精確表示該值。
  • 在替代實現中，即使後面沒有數字，也會寫入小數點字元。
  • 關於無窮大和非數字的轉換樣式，請參見註釋。
 不適用 不適用 不適用 不適用 不適用 不適用
g
G

根據值和精度，將浮點數轉換為十進位制或十進位制指數表示法。

  • 對於 g 轉換樣式，將執行樣式 e 或 f 的轉換。
  • 對於 G 轉換樣式，將執行樣式 E 或 f(C++11 前)F(C++11 起) 的轉換。
  • 設 P 等於非零精度，如果未指定精度則為 6，如果精度為 ​0​ 則為 1。那麼，如果樣式 E 的轉換會有一個指數 X
    • 如果 *P > X ≥ -4*，則轉換的樣式為 f 或 F(C++11 起)，精度為 *P - 1 - X*。
    • 否則，轉換使用樣式 e 或 E，精度為 P − 1。
  • 除非請求替代表示，否則會刪除尾隨零，如果不再有小數部分，也會刪除小數點字元。
  • 關於無窮大和非數字的轉換樣式，請參見註釋。
 不適用 不適用 不適用 不適用 不適用 不適用
n

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

  • 結果被寫入到引數指向的值。
  • 說明符不得包含任何標誌、欄位寬度或精度。
  • 對於 z 修飾符，預期的引數型別是 S*，其中 S 是 std::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。由於在呼叫可變引數函式時會發生提升，因此傳遞這些型別的值是安全的。

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

記憶體寫入轉換說明符 %n 是格式字串依賴使用者輸入時常見的安全漏洞目標。

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

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

[編輯] 返回值

1-3) 成功寫入的字元數，如果發生錯誤則為負值。
4) 成功寫入的字元數，如果發生錯誤則為負值。如果由於 buf_size 限制導致結果字串被截斷，函式將返回如果未施加限制，本應寫入的總字元數（不包括終止空位元組）。

[編輯] 注意

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

[編輯] 示例

執行此程式碼
#include <cstdarg>
#include <cstdio>
#include <ctime>
#include <vector>
 
void debug_log(const char *fmt, ...)
{
    std::time_t t = std::time(nullptr);
    char time_buf[100];
    std::strftime(time_buf, sizeof time_buf, "%D %T", std::gmtime(&t));
    std::va_list args1;
    va_start(args1, fmt);
    std::va_list args2;
    va_copy(args2, args1);
    std::vector<char> buf(1 + std::vsnprintf(nullptr, 0, fmt, args1));
    va_end(args1);
    std::vsnprintf(buf.data(), buf.size(), fmt, args2);
    va_end(args2);
    std::printf("%s [debug]: %s\n", time_buf, buf.data());
}
 
int main()
{
    debug_log("Logging, %d, %d, %d", 1, 2, 3);
}

輸出

04/13/15 15:09:18 [debug]: Logging, 1, 2, 3

[編輯] 另請參見

(C++11)
 將格式化輸出列印到 stdout、檔案流或緩衝區
(函式) [編輯]
(C++11 起)(C++11 起)(C++11 起)
 從 stdin、檔案流或緩衝區讀取格式化輸入
使用可變引數列表
(函式) [編輯]
(C++23)
 使用 型別擦除 引數表示形式列印到支援 Unicode 的 stdout 或檔案流
(函式) [編輯]
(C++23)
 使用 型別擦除 引數表示形式列印到 stdout 或檔案流
(函式) [編輯]
C 文件 關於 vprintf, vfprintf, vsprintf, vsnprintf
取自 "https://cppreference.tw/mwiki/index.php?title=cpp/io/c/vfprintf&oldid=158713"