Namespaces
Variants

std:: printf, std:: fprintf, std:: sprintf, std:: snprintf

From cppreference.net
< cpp ‎ | io ‎ | c
C++
Input/output library
C-style I/O
ヘッダーで定義 <cstdio>
int printf ( const char * format, ... ) ;
(1)
int fprintf ( std:: FILE * stream, const char * format, ... ) ;
(2)
int sprintf ( char * buffer, const char * format, ... ) ;
(3)
int snprintf ( char * buffer, std:: size_t buf_size, const char * format, ... ) ;
(4) (C++11以降)

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

1) 結果を stdout に書き込みます。
2) 結果をファイルストリーム stream に書き込みます。
3) 結果を文字列 buffer に書き込みます。
4) 結果を文字列 buffer に書き込みます。最大で buf_size - 1 文字が書き込まれます。結果の文字列は、null文字で終端されます（ただし buf_size がゼロの場合を除く）。 buf_size がゼロの場合、何も書き込まれず、 buffer はnullポインタでも構いませんが、戻り値（null終端文字を含まない書き込み予定バイト数）は依然として計算され返されます。

sprintf または snprintf の呼び出しによって、オーバーラップするオブジェクト間でコピーが行われる場合、動作は未定義です（例： sprintf ( buf, "%s text" , buf ) ; ）。

目次

パラメータ

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

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

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

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

変換
指定子 		説明 期待される
引数の型
長さ修飾子→ 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 修飾子が使用される場合、引数はまず %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配列に変換されます。
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

unsigned integer を10進数表現 dddd に変換します。

  • Precision は表示する最小桁数を指定します。
  • デフォルトの精度は 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 変換スタイルでは [-]  0x h.hhh  p ±d が使用されます。
  • A 変換スタイルでは [-]  0X h.hhh  P ±d が使用されます。
  • 引数が正規化浮動小数点値の場合、最初の16進数は 0 ではありません。
  • 値が ​ 0 ​ の場合、指数も ​ 0 ​ です。
  • 精度 は16進小数点文字の後に表示される正確な桁数を指定します。
  • デフォルトの精度は値を正確に表現するのに十分です。
  • 代替実装 では、その後ろに数字が続かない場合でも10進小数点文字が書き込まれます。
  • 無限大および非数の変換スタイルについては 注記 を参照してください。
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 となる。
  • 代替表現 が要求されない限り、末尾のゼロは削除され、小数部が残っていない場合は小数点も削除される。
  • 無限大と非数(not-a-number)の変換スタイルについては 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,2) 成功した場合は書き込まれた文字数、エラーが発生した場合は負の値。
3) 成功した場合に書き込まれた文字数（終端のnull文字を含まない）、またはエラーが発生した場合は負の値。
4) 成功した場合に十分に大きなバッファに書き込まれたであろう文字数（終端のnull文字は含まない）、またはエラーが発生した場合は負の値。したがって、（null終端された）出力が完全に書き込まれたのは、返された値が非負かつ buf_size 未満の場合に限ります。

注記

POSIXは エラー時に errno が設定されることを規定しています。また、追加の変換指定子も規定しており、特に引数の順序変更のサポート（ n$ が % の直後に続く場合、 n 番目の 引数を示す）が含まれます。

std::snprintf をゼロの buf_size と buffer に対するヌルポインタで呼び出すことは（二重呼び出しのオーバーヘッドが許容できる場合）、出力を格納するために必要なバッファサイズを決定するのに有用です： 

auto fmt = "sqrt(2) = %f";
int sz = std::snprintf(nullptr, 0, fmt, std::sqrt(2));
std::vector<char> buf(sz + 1); // 注: +1 はヌル終端文字のため
std::sprintf(buf.data(), fmt, std::sqrt(2)); // 確実に収まる

例

このコードを実行 
#include <cinttypes>
#include <cstdint>
#include <cstdio>
#include <limits>
int main()
{
    const char* s = "Hello";
    std::printf("Strings:\n"); // same as std::puts("Strings:");
    std::printf("\t[%10s]\n", s);
    std::printf("\t[%-10s]\n", s);
    std::printf("\t[%*s]\n", 10, s);
    std::printf("\t[%-10.*s]\n", 4, s);
    std::printf("\t[%-*.*s]\n", 10, 4, s);
    std::printf("Characters:\t%c %%\n", 'A');
    std::printf("Integers:\n");
    std::printf("\tDecimal:    \t%i %d %.6i %i %.0i %+i %i\n",
                                  1, 2,   3, 0,   0,  4,-4);
    std::printf("\tHexadecimal:\t%x %x %X %#x\n",
                                  5,10,10,  6);
    std::printf("\tOctal:      \t%o %#o %#o\n",
                                 10, 10,  4);
    std::printf("Floating point:\n");
    std::printf("\tRounding:\t%f %.0f %.32f\n", 1.5, 1.5, 1.3);
    std::printf("\tPadding:\t%05.2f %.2f %5.2f\n", 1.5, 1.5, 1.5);
    std::printf("\tScientific:\t%E %e\n", 1.5, 1.5);
    std::printf("\tHexadecimal:\t%a %A\n", 1.5, 1.5);
    std::printf("\tSpecial values:\t0/0=%g 1/0=%g\n", 0.0/0.0, 1.0/0.0);
    std::printf("Variable width control:\n");
    std::printf("\tright-justified variable width: '%*c'\n", 5, 'x');
    int r = std::printf("\tleft-justified variable width : '%*c'\n", -5, 'x');
    std::printf("(the last printf printed %d characters)\n", r);
    std::printf("Fixed-width types:\n");
    std::uint32_t val = std::numeric_limits<std::uint32_t>::max();
    std::printf("\tLargest 32-bit value is %" PRIu32 " or %#" PRIx32 "\n",
                                                 val,            val);
}

出力例: 

Strings:
	[     Hello]
	[Hello     ]
	[     Hello]
	[Hell      ]
	[Hell      ]
Characters:	A %
Integers:
	Decimal:    	1 2 000003 0  +4 -4
	Hexadecimal:	5 a A 0x6
	Octal:      	12 012 04
Floating point:
	Rounding:	1.500000 2 1.30000000000000004440892098500626
	Padding:	01.50 1.50  1.50
	Scientific:	1.500000E+00 1.500000e+00
	Hexadecimal:	0x1.8p+0 0X1.8P+0
	Special values:	0/0=-nan 1/0=inf
Variable width control:
	right-justified variable width: '    x'
	left-justified variable width : 'x    '
(the last printf printed 41 characters)
Fixed-width types:
	Largest 32-bit value is 4294967295 or 0xffffffff

関連項目

書式化されたワイド文字出力を stdout 、ファイルストリーム、またはバッファに出力する
(関数)
(C++11)
可変引数リストを使用して書式化された出力を stdout 、ファイルストリーム、またはバッファに出力する
可変引数リストを使用
(関数)
文字列をファイルストリームに書き込む
(関数)
書式化された入力を stdin 、ファイルストリーム、またはバッファから読み込む
(関数)
(C++17)
整数または浮動小数点値を文字シーケンスに変換する
(関数)
(C++23)
引数の 書式化 された表現を使用して stdout またはファイルストリームに出力する
(関数テンプレート)
(C++23)
std::print と同じだが、各出力が追加の改行で終了する
(関数テンプレート)
Cドキュメント for printf , fprintf , sprintf , snprintf