名稱空間
變體
操作

vwprintf, vfwprintf, vswprintf, vwprintf_s, vfwprintf_s, vswprintf_s, vsnwprintf_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)  
直接輸入/輸出
格式化輸出
(C99)(C11)(C11)(C11)(C11)
vwprintfvfwprintfvswprintfvwprintf_svfwprintf_svswprintf_svsnwprintf_s
(C95)(C95)(C95)(C11)(C11)(C11)(C11)
檔案定位
錯誤處理
檔案操作
 
在標頭檔案 <wchar.h> 中定義
(1)
int vwprintf( const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vwprintf( const wchar_t* restrict format, va_list vlist );
 (C99 起)
(2)
int vfwprintf( FILE* stream, const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vfwprintf( FILE* restrict stream,
               const wchar_t* restrict format, va_list vlist );
 (C99 起)
(3)
int vswprintf( wchar_t* buffer, size_t bufsz,
               const wchar_t* format, va_list vlist );
 (自 C95 起)
(直到 C99)
int vswprintf( wchar_t* restrict buffer, size_t bufsz,
               const wchar_t* restrict format, va_list vlist );
 (C99 起)
int vwprintf_s( const wchar_t* restrict format, va_list vlist);
 (4) (C11 起)
int vfwprintf_s( FILE* restrict stream,
                 const wchar_t* restrict format, va_list vlist);
 (5) (C11 起)
int vswprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                 const wchar_t* restrict format, va_list vlist);
 (6) (C11 起)
int vsnwprintf_s( wchar_t* restrict buffer, rsize_t bufsz,
                  const wchar_t* restrict format, va_list vlist);
 (7) (C11 起)

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

1) 將結果寫入 stdout。
2) 將結果寫入檔案流 stream。
3) 將結果寫入寬字串 buffer。最多寫入 bufsz - 1 個寬字元，後跟空寬字元。除非 bufsz 為零，否則生成的寬字串將以空寬字元終止。
4-6) 與 (1-3) 相同，但以下錯誤會在執行時檢測到並呼叫當前安裝的 約束處理函式
  • format 中存在轉換說明符 %n
  • 任何對應於 %s 的引數都是空指標
  • format 或 buffer 是空指標
  • bufsz 為零或大於 RSIZE_MAX / sizeof(wchar_t)
  • 在任何字串和字元轉換說明符中發生編碼錯誤
  • (僅適用於 vswprintf_s)，要儲存在 buffer 中的字串（包括尾隨的寬空字元）將超出 bufsz。
7) 與 (6) 相同，但它會截斷結果以適應由 buffer 指向的陣列。
與所有邊界檢查函式一樣，只有當實現定義了 __STDC_LIB_EXT1__ 且使用者在包含 <stdio.h> 之前將 __STDC_WANT_LIB_EXT1__ 定義為整數常量 1 時，才能保證 vwprintf_s、vfwprintf_s、vswprintf_s 和 vsnwprintf_s 可用。

目錄

[edit] 引數

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


format 字串由普通寬字元（除了 %）組成，這些字元按原樣複製到輸出流中，以及轉換規範。每個轉換規範具有以下格式

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

以下格式說明符可用：

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

寫入單個字元。

  • 引數首先轉換為 wchar_t，如同呼叫 btowc。
  • 如果使用了 l 修飾符，則 wint_t 引數首先轉換為 wchar_t。
 不適用 不適用
int
wint_t
 不適用 不適用 不適用 不適用 不適用
s

寫入字元字串。

  • 引數必須是指向字元陣列初始元素的指標，該陣列包含以初始移位狀態開始的多位元組字元序列，該序列被轉換為寬字元陣列，如同透過呼叫 mbrtowc 並使用零初始化的轉換狀態。
  • *精度*指定要寫入的最大寬字元數。如果未指定*精度*，則寫入所有寬字元，直到但不包括第一個空終止符。
  • 如果使用了 l 說明符，則引數必須是指向 wchar_t 陣列初始元素的指標。
 不適用 不適用
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 修改的字串。

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

[edit] 返回值

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

[edit] 注意

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

雖然窄字串提供了 vsnprintf，這使得可以確定所需的輸出緩衝區大小，但寬字串沒有等效項（直到 C11 的 vsnwprintf_s），為了確定緩衝區大小，程式可能需要呼叫 vswprintf，檢查結果值，並重新分配更大的緩衝區，然後再次嘗試直到成功。

vsnwprintf_s，與 vswprintf_s 不同，會將結果截斷以適應由 buffer 指向的陣列，儘管截斷被大多數邊界檢查函式視為錯誤。

[edit] 示例

執行此程式碼
#include <locale.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include <time.h>
#include <wchar.h>
 
void debug_wlog(const wchar_t* 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 args;
    va_start(args, fmt);
    wchar_t buf[1024];
    int rc2 = vswprintf(buf, sizeof buf / sizeof *buf, fmt, args);
    va_end(args);
 
    if(rc2 > 0)
       wprintf(L"%s [debug]: %ls\n", time_buf, buf);
    else
       wprintf(L"%s [debug]: (string too long)\n", time_buf);
}
 
int main(void)
{
    setlocale(LC_ALL, "");
    debug_wlog(L"Logging, %d, %d, %d", 1, 2, 3);
}

可能的輸出

02/20/15 22:12:38.476575 UTC [debug]: Logging, 1, 2, 3

[edit] 參考

  • C23 標準 (ISO/IEC 9899:2024)
  • 7.29.2.5 vfwprintf 函式 (p: TBD)
  • 7.29.2.7 vswprintf 函式 (p: TBD)
  • 7.29.2.9 vwprintf 函式 (p: TBD)
  • K.3.9.1.6 vfwprintf_s 函式 (p: TBD)
  • K.3.9.1.8 vsnwprintf_s 函式 (p: TBD)
  • K.3.9.1.9 vswprintf_s 函式 (p: TBD)
  • K.3.9.1.11 vwprintf_s 函式 (p: TBD)
  • C17 標準 (ISO/IEC 9899:2018)
  • 7.29.2.5 vfwprintf 函式 (p: TBD)
  • 7.29.2.7 vswprintf 函式 (p: TBD)
  • 7.29.2.9 vwprintf 函式 (p: TBD)
  • K.3.9.1.6 vfwprintf_s 函式 (p: TBD)
  • K.3.9.1.8 vsnwprintf_s 函式 (p: TBD)
  • K.3.9.1.9 vswprintf_s 函式 (p: TBD)
  • K.3.9.1.11 vwprintf_s 函式 (p: TBD)
  • C11 標準 (ISO/IEC 9899:2011)
  • 7.29.2.5 vfwprintf 函式 (p: 417-418)
  • 7.29.2.7 vswprintf 函式 (p: 419)
  • 7.29.2.9 vwprintf 函式 (p: 420)
  • K.3.9.1.6 vfwprintf_s 函式 (p: 632)
  • K.3.9.1.8 vsnwprintf_s 函式 (p: 633-634)
  • K.3.9.1.9 vswprintf_s 函式 (p: 634-635)
  • K.3.9.1.11 vwprintf_s 函式 (p: 636)
  • C99 標準 (ISO/IEC 9899:1999)
  • 7.24.2.5 vfwprintf 函式 (p: 363)
  • 7.24.2.7 vswprintf 函式 (p: 364)
  • 7.24.2.9 vwprintf 函式 (p: 365)

[edit] 另請參閱

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