名前空間
変種
操作

std::vprintf、std::vfprintf、std::vsprintf、std::vsnprintf

From cppreference.com
< cpp‎ | io‎ | c
 
C++
コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ
 
入出力ライブラリ
 
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 未満の文字が書き込まれます。結果の文字列は、buf_size がゼロでない限り、ヌル文字で終端されます。buf_size がゼロの場合、何も書き込まれず、buffer はヌルポインタになる可能性がありますが、返り値（ヌル終端子を含まない、書き込まれるバイト数）は依然として計算され返されます。

目次

[編集] パラメータ

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

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

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

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

変換
指定子		 説明 期待される
引数型
長さ修飾子→ hh h なし 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 修飾子を使用する場合、引数は最初に、wchar_t[2] 引数を使用した %ls と同等に文字列として変換されます。
 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 配列に変換されます。
 N/A N/A
char*
wchar_t*
 N/A N/A N/A N/A N/A
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 です。
  • 代替実装では、小数点文字の後に桁がない場合でも小数点文字が書き込まれます。
  • 無限大および非数変換のスタイルについては注釈を参照してください。
 N/A N/A N/A N/A N/A N/A
a
A

(C++11)

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

  • a 変換スタイルには [-] 0xh.hhh p±d が使用されます。
  • A 変換スタイルには [-] 0Xh.hhh P±d が使用されます。
  • 引数が正規化された浮動小数点値の場合、最初の16進数字は 0 ではありません。
  • 値が ​0​ の場合、指数も ​0​ です。
  • 精度は16進小数点文字の後に表示される桁の厳密な数を指定します。
  • デフォルトの精度は値の正確な表現に十分です。
  • 代替実装では、小数点文字の後に桁がない場合でも小数点文字が書き込まれます。
  • 無限大および非数変換のスタイルについては注釈を参照してください。
 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 を精度とし、精度が指定されていない場合は 6、精度が ​0​ の場合は 1 とします。その場合、スタイル E で変換した場合、指数が X となるとします。
    • P > X ≥ −4 の場合、スタイル f または F(C++11以降)、精度 P − 1 − X で変換します。
    • それ以外の場合、スタイル e または E、精度 P − 1 で変換します。
  • 代替表現が要求されない限り、後続のゼロは削除され、小数部分が残らない場合は小数点文字も削除されます。
  • 無限大および非数変換のスタイルについては注釈を参照してください。
 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

[編集] 関連項目

(C++11)
 stdout、ファイルストリーム、またはバッファにフォーマットされた出力を書き込む
(関数) [編集]
(C++11)(C++11)(C++11)
 stdin、ファイルストリーム、またはバッファから書式付き入力を読み取ります。
可変長引数リストを使用する
(関数) [編集]
(C++23)
 引数の型消去された表現を用いて、Unicode対応のstdoutまたはファイルストリームに出力する
(関数) [編集]
(C++23)
 引数の型消去された表現を用いて、stdoutまたはファイルストリームに出力する
(関数) [編集]
C ドキュメント (vprintf, vfprintf, vsprintf, vsnprintf)
"https://ja.cppreference.dev/mwiki/index.php?title=cpp/io/c/vfprintf&oldid=158713" から取得
English 日本語 中文(简体) 中文(繁體)