Namespaces
Variants

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

From cppreference.net
< cpp ‎ | io ‎ | c
ヘッダーで定義 <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 がゼロでない限り、null文字で終端されます。 buf_size がゼロの場合、何も書き込まれず、 buffer はnullポインタでも構いませんが、戻り値(null終端文字を含まない書き込み予定バイト数)は依然として計算され返されます。

目次

パラメータ

stream - 出力先ファイルストリーム
buffer - 書き込み先文字列へのポインタ
buf_size - 書き込む最大文字数
format - データの解釈方法を指定するヌル終端文字列へのポインタ
vlist - 出力するデータを含む可変引数リスト

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

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

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

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

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

  • 引数はまず unsigned char に変換されます。
  • l 修飾子が使用される場合、引数はまず %ls による wchar_t [ 2 ] 引数の文字列変換と同様に処理されます。
N/A N/A
int
std::wint_t
N/A N/A N/A N/A N/A
s

文字列 を書き込みます。

  • 引数は文字配列の先頭要素へのポインタでなければなりません。
  • 精度 は書き込む最大バイト数を指定します。 精度 が指定されていない場合、最初のナルターミネータまでのすべてのバイトを書き込みます(ナルターミネータは含みません)。
  • l 指定子が使用される場合、引数は wchar_t の配列の先頭要素へのポインタでなければならず、ゼロ初期化された変換状態で std::wcrtomb を呼び出したかのようにchar配列に変換されます。
該当なし 該当なし
char *
wchar_t *
該当なし 該当なし 該当なし 該当なし 該当なし
d
i

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

  • 精度 は表示する最小桁数を指定します。デフォルトの精度は 1 です。
  • 変換された値と精度の両方が 0 の場合、変換結果は文字を生成しません。
  • z 修飾子の場合、期待される引数型は std::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
std::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 (C++11)

浮動小数点数 [-]ddd.ddd 形式の10進数表記に変換します。

  • 精度 は小数点以下の表示桁数を正確に指定します。
  • デフォルトの精度は 6 です。
  • 代替実装 では、後続する数字がなくても小数点が常に表示されます。
  • 無限大および非数値の変換形式については 注記 を参照してください。
N/A N/A
double
double (C++11)
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

(C++11)

浮動小数点数を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 (C++11まで) F (C++11以降) スタイルでの変換が実行されます。
  • P を、精度が0でない場合はその値、精度が指定されていない場合は 6 、精度が 0 の場合は 1 とします。次に、 E スタイルでの変換の指数が X の場合:
    • P > X ≥ −4 の場合、変換は f または F (C++11以降) スタイルで実行され、精度は P − 1 − X となります。
    • それ以外の場合、変換は e または E スタイルで実行され、精度は P − 1 となります。
  • 代替表現 が要求されない限り、末尾のゼロは削除され、小数部が残っていない場合は小数点も削除されます。
  • 無限大と非数の変換スタイルについては notes を参照してください。
N/A N/A N/A N/A N/A N/A
n

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

  • 結果は引数が指す値に 書き込まれます
  • 指定には フラグ フィールド幅 、または 精度 を含めることはできません。
  • z 修飾子の場合、期待される引数の型は S * であり、ここで S std:: 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 に変換されます。可変引数関数が呼び出されるときに行われるプロモーションにより、これらの型の値を渡すことは安全です。

固定幅文字型( std::int8_t など)の正しい変換指定はヘッダー <cinttypes> で定義されています(ただし PRIdMAX PRIuMAX などは %jd %ju などの同義語です)。

メモリ書き込み変換指定子 %n は、フォーマット文字列がユーザー入力に依存するセキュリティ攻撃の一般的な標的です。

各変換指定子の動作の後に シーケンスポイント があります。これにより、複数の %n 結果を同じ変数に格納したり、エッジケースとして、同じ呼び出し内で以前の %n によって変更された文字列を表示したりすることが可能になります。

変換指定が無効な場合、動作は未定義です。

戻り値

1-3) 成功した場合は書き込まれた文字数、エラーが発生した場合は負の値。
4) 成功した場合に書き込まれた文字数、エラー発生時は負の値。結果の文字列が buf_size の制限により切り詰められた場合、この関数は制限が課されていなかった場合に書き込まれたであろう総文字数(終端ナルバイトを含まない)を返します。

注記

これらの関数はすべて少なくとも1回 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

関連項目

書式化された出力を stdout 、ファイルストリーム、またはバッファに出力する
(関数)
(C++11) (C++11) (C++11)
可変引数リストを使用して stdin 、ファイルストリーム、またはバッファから書式化された入力を読み取る
可変引数リストを使用
(関数)
Unicode対応の stdout またはファイルストリームに 型消去された 引数表現を使用して出力する
(関数)
stdout またはファイルストリームに 型消去された 引数表現を使用して出力する
(関数)
Cドキュメント for vprintf , vfprintf , vsprintf , vsnprintf