Namespaces
Variants

wprintf, fwprintf, swprintf, wprintf_s, fwprintf_s, swprintf_s, snwprintf_s

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Direct input/output
Formatted output
(C99) (C11) (C11) (C11) (C11)
wprintf fwprintf swprintf wprintf_s fwprintf_s swprintf_s snwprintf_s
(C95) (C95) (C95) (C11) (C11) (C11) (C11)
File positioning
Error handling
Operations on files
定義先ヘッダ <wchar.h>
(1)
int wprintf ( const wchar_t * format, ... ) ;
(C95以降)
(C99まで)
int wprintf ( const wchar_t * restrict format, ... ) ;
(C99以降)
(2)
int fwprintf ( FILE * stream, const wchar_t * format, ... ) ;
(C95以降)
(C99まで)
int fwprintf ( FILE * restrict stream,
const wchar_t * restrict format, ... ) ;
(C99以降)
(3)
int swprintf ( wchar_t * buffer, size_t bufsz,
const wchar_t * format, ... ) ;
(C95以降)
(C99まで)
int swprintf ( wchar_t * restrict buffer, size_t bufsz,
const wchar_t * restrict format, ... ) ;
(C99以降)
int wprintf_s ( const wchar_t * restrict format, ... ) ;
(4) (C11以降)
int fwprintf_s ( FILE * restrict stream,
const wchar_t * restrict format, ... ) ;
(5) (C11以降)
int swprintf_s ( wchar_t * restrict buffer, rsize_t bufsz,
const wchar_t * restrict format, ... ) ;
(6) (C11以降)
int snwprintf_s ( wchar_t * restrict s, rsize_t n,
const wchar_t * restrict format, ... ) ;
(7) (C11以降)

指定された場所からデータを読み込み、ワイド文字列相当に変換し、様々なシンクに結果を書き込みます。

1) 結果を stdout に書き込みます。
2) 結果をファイルストリーム stream に書き込みます。
3) bufsz がゼロより大きい場合、結果をワイド文字列 buffer に書き込みます。最大で bufsz - 1 個のワイド文字が書き込まれ、その後ろにヌルワイド文字が続きます。 bufsz がゼロの場合、何も書き込まれません（また buffer はヌルポインタでも構いません）。
4-6) 以下を除き (1-3) と同じですが、以下のエラーが実行時に検出され、現在インストールされている constraint handler 関数を呼び出します：
  • 変換指定子 %n が format 内に存在する
  • %s に対応する引数のいずれかがnullポインタである
  • format または buffer がnullポインタである
  • bufsz がゼロまたは RSIZE_MAX / sizeof ( wchar_t ) より大きい
  • 文字列および文字変換指定子でエンコーディングエラーが発生する
  • ( swprintf_s のみ) 書き込まれるワイド文字数（null文字を含む）が bufsz を超える場合
7) (6) と同様だが、結果をsが指す配列内に収まるように切り詰める。
すべての境界チェック付き関数と同様に、 wprintf_s 、 fwprintf_s 、 swprintf_s 、および snwprintf_s は、実装によって __STDC_LIB_EXT1__ が定義され、かつユーザーが <stdio.h> をインクルードする前に __STDC_WANT_LIB_EXT1__ を整数定数 1 に定義した場合にのみ利用可能であることが保証される。

目次

パラメータ

stream - 書き込み先の出力ファイルストリーム
buffer - 書き込み先のワイド文字列へのポインタ
bufsz - 最大 bufsz - 1 ワイド文字まで書き込み可能（ナルターミネータ含む）
format - データの解釈方法を指定するナル終端ワイド文字列へのポインタ
... - 出力するデータを指定する引数。 デフォルト引数プロモーション 後の引数が対応する変換指定子が期待する型と一致しない場合、または format が要求するより引数が少ない場合、動作は未定義。 format が要求するより引数が多い場合、余分な引数は評価されるが無視される。


書式文字列は、出力ストリームに変更されずにコピーされる通常のワイド文字（ % を除く）と変換指定子で構成されます。各変換指定子は以下の形式を持ちます：

  • 導入 % 文字。
  • (オプション) 変換の動作を変更する1つ以上のフラグ:
  • - : 変換結果がフィールド内で左揃えされます（デフォルトでは右揃え）。
  • + : 符号付き変換の場合、常に変換結果の前に符号が付加されます（デフォルトでは負の場合のみマイナス記号が付きます）。
  • space : 符号付き変換の結果が符号文字で始まらない場合、または空の場合、結果の前にスペースが付加されます。 + フラグが存在する場合は無視されます。
  • # : 変換の 代替形式 が実行されます。正確な効果については以下の表を参照してください。それ以外の場合の動作は未定義です。
  • 0 : 整数および浮動小数点数変換の場合、 space 文字の代わりに先行ゼロを使用してフィールドが埋められます。整数の場合、精度が明示的に指定されている場合は無視されます。このフラグを使用した他の変換では動作は未定義です。 - フラグが存在する場合は無視されます。
  • (オプション) 整数値または * で、最小フィールド幅を指定します。結果は、必要に応じて、右揃えの場合は左側に、左揃えの場合は右側に、 スペース 文字（デフォルト）でパディングされます。 * が使用される場合、幅は int 型の追加の引数によって指定され、この引数は変換対象の引数と、精度を指定する引数（ある場合）の前に現れます。引数の値が負の場合、 - フラグが指定され、正のフィールド幅となります（注: これは最小幅です: 値が切り捨てられることはありません。）。
  • (オプション) . に続く整数値または * 、あるいは何も指定されない場合、変換の 精度 を指定します。 * が使用される場合、 精度 は int 型の追加引数によって指定されます。この引数は変換対象の引数の前に、最小フィールド幅を指定する引数（存在する場合）の後に配置されます。この引数の値が負の場合、無視されます。数値も * も使用されない場合、精度はゼロと見なされます。 精度 の正確な効果については以下の表を参照してください。
  • (optional) 長さ修飾子 引数のサイズを指定する（変換形式指定子と組み合わせて、対応する引数の型を指定する）。
  • 変換フォーマット指定子。

以下のフォーマット指定子が利用可能です：

変換
指定子 		説明 期待される
引数の型
長さ修飾子→ hh h なし l ll j z t L
C99以降でのみ利用可能→ 可 可 可 可 可
% リテラル % を書き出す。完全な変換指定は %% でなければならない。 N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

単一文字 を書き込みます。

  • 引数はまず wchar_t に変換されます（ btowc を呼び出すかのように）。
  • l 修飾子が使用される場合、 wint_t 引数はまず wchar_t に変換されます。
N/A N/A
int
wint_t
N/A N/A N/A N/A N/A
s

文字列 を書き込みます。

  • 引数は、初期シフト状態で始まるマルチバイト文字シーケンスを含む文字配列の先頭要素へのポインタでなければなりません。これは、ゼロ初期化された変換状態で mbrtowc を呼び出したかのようにワイド文字配列に変換されます。
  • 精度 は書き込まれるワイド文字の最大数を指定します。 精度 が指定されていない場合、最初のナルターミネータまで（ナルターミネータを除く）のすべてのワイド文字を書き込みます。
  • l 指定子が使用される場合、引数は wchar_t の配列の先頭要素へのポインタでなければなりません。
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
d
i

符号付き整数 を10進数表現 [-]dddd に変換します。

  • 精度 は表示する最小桁数を指定します。デフォルトの精度は 1 です。
  • 変換された値と精度の両方が ​ 0 ​ の場合、変換結果は文字を出力しません。
  • z 修飾子の場合、期待される引数の型は size_t の符号付きバージョンです。
signed char
short
int
long
long long
※
N/A
o

符号なし整数 を8進数表現 oooo に変換します。

  • 精度 は表示する最小桁数を指定します。デフォルトの精度は 1 です。
  • 変換された値と精度の両方が ​ 0 ​ の場合、変換結果は文字を出力しません。
  • 代替実装 では、必要に応じて精度が増加され、先頭に1つのゼロが書き込まれます。その場合、変換された値と精度の両方が ​ 0 ​ の場合、単一の ​ 0 ​ が書き込まれます。
unsigned char
unsigned short
unsigned int
unsigned long
unsigned long long
ptrdiff_t の符号なしバージョン
N/A
x
X

符号なし整数 を16進数表現 hhhh に変換します。

  • x 変換では abcdef の文字が使用されます。
  • X 変換では ABCDEF の文字が使用されます。
  • 精度 は表示される最小桁数を指定します。デフォルトの精度は 1 です。
  • 変換された値と精度の両方が ​ 0 ​ の場合、変換結果は文字を出力しません。
  • 代替実装 では、変換された値が非ゼロの場合、結果に 0x または 0X が前置されます。
N/A
u

符号なし整数 を10進数表現 dddd に変換します。

  • 精度 は表示する最小桁数を指定します。
  • デフォルトの精度は 1 です。
  • 変換された値と精度の両方が ​ 0 ​ の場合、変換結果は文字を出力しません。
N/A
f
F (C99)

浮動小数点数 を [-]ddd.ddd スタイルの10進表記に変換します。

  • 精度 は小数点以下の表示桁数を指定します。
  • デフォルトの精度は 6 です。
  • 代替実装 では、小数点以下に数字が続かない場合でも小数点が書き込まれます。
  • 無限大および非数値の変換スタイルについては 注記 を参照してください。
N/A N/A
double
double (C99)
N/A N/A N/A N/A
long double
e
E

浮動小数点数 を10進指数表記に変換します。

  • e 変換スタイルでは [-]d.ddd  e ±dd 形式が使用されます。
  • E 変換スタイルでは [-]d.ddd  E ±dd 形式が使用されます。
  • 指数部は少なくとも2桁で、必要な場合のみより多くの桁が使用されます。
  • 値が ​ 0 ​ の場合、指数も ​ 0 ​ になります。
  • 精度 は小数点以下の表示桁数を指定します。
  • デフォルトの精度は 6 です。
  • 代替実装 では、後続する数字がない場合でも小数点が書き込まれます。
  • 無限大と非数の変換スタイルについては notes を参照してください。
N/A N/A N/A N/A N/A N/A
a
A

(C99)

浮動小数点数を16進指数表記に変換します。

  • a 変換スタイルでは [-]  0x h.hhh  p ±d が使用されます。
  • A 変換スタイルでは [-]  0X h.hhh  P ±d が使用されます。
  • 引数が正規化浮動小数点値の場合、最初の16進数は 0 ではありません。
  • 値が ​ 0 ​ の場合、指数も ​ 0 ​ になります。
  • 精度 は16進小数点文字の後に表示される正確な桁数を指定します。
  • デフォルトの精度は値を正確に表現するのに十分です。
  • 代替実装 では、後続する桁がなくても10進小数点文字が書き込まれます。
  • 無限大および非数の変換スタイルについては notes を参照してください。
N/A N/A N/A N/A N/A N/A
g
G

浮動小数点数 を値と 精度 に応じて10進数表記または10進指数表記に変換します。

  • g 変換スタイルの場合、 e または f スタイルでの変換が行われます。
  • G 変換スタイルの場合、 E または f (C99以前) F (C99以降) スタイルでの変換が行われます。
  • P を、精度が0でない場合はその値、精度が指定されていない場合は 6 、精度が ​ 0 ​ の場合は 1 とします。このとき、 E スタイルでの変換における指数が X の場合：
    • P > X ≥ −4 の場合、 f または F (C99以降) スタイルで精度 P − 1 − X の変換が行われます。
    • それ以外の場合、 e または E スタイルで精度 P − 1 の変換が行われます。
  • 代替表現 が要求されない限り、末尾のゼロは削除され、小数部が残っていない場合は小数点も削除されます。
  • 無限大と非数の変換スタイルについては 注記 を参照してください。
N/A N/A N/A N/A N/A N/A
n

この関数呼び出しでこれまでに 書き込まれた文字数 を返します。

  • 結果は引数が指す値に 書き込まれます 。
  • 指定には フラグ 、 フィールド幅 、または 精度 を含めることはできません。
  • z 修飾子の場合、期待される引数の型は S * であり、ここで S は size_t の符号付きバージョンです。
signed char *
short *
int *
long *
long long *
※
N/A
p

実装定義の文字シーケンスを書き込み、 ポインタ を定義します。

N/A N/A
void *
N/A N/A N/A N/A N/A N/A
注記

浮動小数点変換関数は、無限大を 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,2) 成功した場合に書き込まれたワイド文字数、エラー発生時は負の値。
3) 成功した場合に書き込まれたワイド文字数（終端ナルワイド文字を除く）、またはエンコーディングエラーが発生した場合、あるいは生成される文字数が bufsz 以上の場合（ bufsz がゼロの場合を含む）は負の値。
4,5) 成功した場合に書き込まれたワイド文字数、エラーが発生した場合は負の値。
6) バッファに書き込まれたワイド文字の数（終端のnull文字は含まない）。エンコーディングエラーおよびオーバーフロー時には負の値を返す。その他のエラー時にはゼロを返す。
7) 終端ナル文字を除くワイド文字の数（ buffer に書き込まれたであろう文字数）を返す。エラーが発生した場合は負の値を返す。（つまり、戻り値が非負かつ bufsz より小さい場合にのみ、書き込みが成功し完了したことを意味する）

注記

ナロウ文字列では snprintf が提供されており、必要な出力バッファサイズを決定することが可能ですが、ワイド文字列には同等の機能がありません ( snwprintf_s まで ) (C11以降) 。バッファサイズを決定するために、プログラムは swprintf を呼び出し、結果の値をチェックし、より大きなバッファを再割り当てして、成功するまで再試行する必要がある場合があります。

snwprintf_s は、 swprintf_s とは異なり、 buffer が指す配列内に収まるように結果を切り詰めます。これは、ほとんどの境界チェック付き関数では切り詰めがエラーとして扱われるにもかかわらず行われます。

例

このコードを実行 
#include <locale.h>
#include <wchar.h>
int main(void)
{
    char narrow_str[] = "z\u00df\u6c34\U0001f34c";
                  // or "zß水🍌"
                  // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9f\x8d\x8c";
    wchar_t warr[29]; // the expected string is 28 characters plus 1 null terminator
    setlocale(LC_ALL, "en_US.utf8");
    swprintf(warr, sizeof warr / sizeof* warr,
             L"Converted from UTF-8: '%s'", narrow_str);
    wprintf(L"%ls\n", warr);
}

出力: 

Converted from UTF-8: 'zß水🍌'

参考文献

  • C23規格 (ISO/IEC 9899:2024):
  • 7.29.2.1 fwprintf関数 (p: TBD)
  • 7.29.2.3 swprintf関数 (p: TBD)
  • 7.29.2.11 wprintf関数 (p: TBD)
  • K.3.9.1.1 fwprintf_s関数 (p: TBD)
  • K.3.9.1.4 swprintf_s関数 (p: TBD)
  • K.3.9.1.13 wprintf_s関数 (p: TBD)
  • C17規格 (ISO/IEC 9899:2018):
  • 7.29.2.1 fwprintf関数 (p: TBD)
  • 7.29.2.3 swprintf関数 (p: TBD)
  • 7.29.2.11 wprintf関数 (p: TBD)
  • K.3.9.1.1 fwprintf_s関数 (p: TBD)
  • K.3.9.1.4 swprintf_s関数 (p: TBD)
  • K.3.9.1.13 wprintf_s関数 (p: TBD)
  • C11標準（ISO/IEC 9899:2011）：
  • 7.29.2.1 fwprintf関数（p: 403-410）
  • 7.29.2.3 swprintf関数（p: 416）
  • 7.29.2.11 wprintf関数（p: 421）
  • K.3.9.1.1 fwprintf_s関数（p: 628）
  • K.3.9.1.4 swprintf_s関数（p: 630-631）
  • K.3.9.1.13 wprintf_s関数（p: 637-638）
  • C99規格 (ISO/IEC 9899:1999):
  • 7.24.2.1 fwprintf関数 (p: 349-356)
  • 7.24.2.3 swprintf関数 (p: 362)
  • 7.24.2.11 wprintf関数 (p: 366)

関連項目

(C99) (C11) (C11) (C11) (C11)
書式付き出力を stdout 、ファイルストリーム、またはバッファに出力する
(関数)
(C95) (C95) (C95) (C11) (C11) (C11) (C11)
可変長引数リストを使用して書式付きワイド文字出力を stdout 、ファイルストリーム
またはバッファに出力する
(関数)
(C95)
ワイド文字列をファイルストリームに書き込む
(関数)
C++ documentation for wprintf , fwprintf , swprintf