scanf、fscanf、sscanf、scanf_s、fscanf_s、sscanf_s

ヘッダー `<stdio.h>` で定義
	(1)
int scanf( const char *format, ... );			(C99まで)
int scanf( const char *restrict format, ... );			(C99以降)
		(2)
int fscanf( FILE stream, const char format, ... );				(C99まで)
int fscanf( FILE restrict stream, const char restrict format, ... );				(C99以降)
			(3)
int sscanf( const char buffer, const char format, ... );					(C99まで)
int sscanf( const char restrict buffer, const char restrict format, ... );					(C99以降)
int scanf_s(const char *restrict format, ...);				(4)	(C11 以降)
int fscanf_s(FILE restrict stream, const char restrict format, ...);				(5)	(C11 以降)
int sscanf_s(const char restrict buffer, const char restrict format, ...);				(6)	(C11 以降)

様々なソースからデータを読み込み、format に従って解釈し、結果を指定された場所に格納します。

1) stdin からデータを読み込みます。

2) ファイルストリーム stream からデータを読み込みます。

3) null終端文字列 buffer からデータを読み込みます。文字列の終端に達することは、fscanf におけるファイル終端条件に相当します。

4-6) (1-3) と同じですが、%c、%s、%[ の変換指定子は、通常はポインタと、受信配列のサイズを示す rsize_t 型の値（単一文字を %c で読み込む場合に 1 になることがある）の2つの引数を必要とします。また、実行時に以下のエラーが検出され、現在インストールされている制約ハンドラ関数が呼び出されます。

ポインタ型引数のいずれかがヌルポインタである場合
format、stream、または buffer がヌルポインタである場合
%c、%s、または %[ によって書き込まれる文字数に、終端の null 文字を加えたものが、それぞれの変換指定子に指定された2番目の引数 (rsize_t) を超える。
オプションで、不明な変換指定子など、その他の検出可能なエラー

すべての境界チェック付き関数と同様に、scanf_s、fscanf_s、sscanf_s は、実装によって __STDC_LIB_EXT1__ が定義され、かつユーザーが <stdio.h> をインクルードする前に __STDC_WANT_LIB_EXT1__ を整数定数 1 として定義した場合にのみ、利用が保証されます。

% 以外の空白でないマルチバイト文字：フォーマット文字列内の各文字は、入力ストリームから同一の文字を1つ消費するか、ストリームの次の文字が一致しない場合にファンクションの失敗を引き起こします。
空白文字：フォーマット文字列内の任意の単一空白文字は、入力から連続するすべての空白文字を消費します（isspace をループで呼び出した場合と同様に決定されます）。フォーマット文字列内の "\n"、" "、"\t\t"、またはその他の空白文字との間に違いはありません。
変換指定。各変換指定は次の形式です。

導入の % 文字。

(オプション) 代入抑制文字 *。このオプションが存在する場合、関数は変換の結果をいかなる受信引数にも代入しません。

(オプション) 最大フィールド幅 を指定する整数（0より大きい）。つまり、現在の変換指定によって指定された変換を実行する際に、関数が消費できる最大文字数です。%s および %[ は、幅が指定されていない場合、バッファオーバーフローを引き起こす可能性があることに注意してください。

(オプション) 受け取る引数のサイズ、つまり実際の宛先型を指定する 長さ修飾子。これは変換精度とオーバーフロー規則に影響します。デフォルトの宛先型は変換型ごとに異なります（下記の表を参照）。

変換フォーマット指定子。

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

変換指定子	説明	期待される引数型
長さ修飾子→		`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`	文字または文字のシーケンスにマッチします。幅指定子が使用されている場合、正確に width 個の文字にマッチします（引数は十分なスペースを持つ配列へのポインタでなければなりません）。 %s および %[ とは異なり、ヌル文字を配列に追加しません。	N/A	N/A	char*	wchar_t*	N/A	N/A	N/A	N/A	N/A
`s`	非空白文字のシーケンス（文字列）にマッチします。幅指定子が使用されている場合、width 個まで、または最初の空白文字まで（どちらか早い方）にマッチします。マッチした文字に加えて常にヌル文字を格納します（したがって、引数配列は少なくとも width+1 文字のスペースが必要です）。
`[`set `]`	set 文字セットからの空でない文字シーケンスにマッチします。セットの最初の文字が `^` の場合、セットに含まれないすべての文字にマッチします。セットが `]` または `^]` で始まる場合、`]` 文字もセットに含まれます。スキャンセット内の非初期位置にある `-` 文字が、`[0-9]` のように範囲を示すかどうかは、実装定義です。幅指定子が使用されている場合、width までのみマッチします。マッチした文字に加えて常にヌル文字を格納します（したがって、引数配列は少なくとも width+1 文字のスペースが必要です）。
`d`	10進整数にマッチします。数値のフォーマットは、base 引数に 10 を指定した場合の strtol が期待するフォーマットと同じです。	signed char* または unsigned char*	signed short* または unsigned short*	signed int* または unsigned int*	signed long* または unsigned long*	signed long long* または unsigned long long*	intmax_t* または uintmax_t*	size_t*	ptrdiff_t*	N/A
`i`	整数にマッチします。数値のフォーマットは、base 引数に 0 を指定した場合（最初の数文字の解析で基数が決定される）の strtol が期待するフォーマットと同じです。
`u`	符号なし 10進整数にマッチします。数値のフォーマットは、base 引数に 10 を指定した場合の strtoul が期待するフォーマットと同じです。
`o`	符号なし 8進整数にマッチします。数値のフォーマットは、base 引数に 8 を指定した場合の strtoul が期待するフォーマットと同じです。
`x` `X`	符号なし 16進整数にマッチします。数値のフォーマットは、base 引数に 16 を指定した場合の strtoul が期待するフォーマットと同じです。
`n`	これまでに読み取った文字数を返します。入力は消費されません。代入カウントは増加しません。指定子に代入抑制演算子が定義されている場合、動作は未定義です。
`a` (C99) `A` (C99) `e` `E` `f` `F` (C99) `g` `G`	浮動小数点数にマッチします。 strtof が期待するフォーマットと同じです。	N/A	N/A	float*	double*	N/A	N/A	N/A	N/A	long double*
`p`	ポインタを定義する実装定義の文字シーケンスにマッチします。 `printf` ファミリの関数は、`%p` 書式指定子を使用して同じシーケンスを生成するはずです。	N/A	N/A	void**	N/A	N/A	N/A	N/A	N/A	N/A
注釈
n 以外のすべての変換指定子について、指定されたフィールド幅を超えず、変換指定子が期待するものとまったく同じか、期待されるシーケンスのプレフィックスである入力文字の最長シーケンスが、ストリームから消費されます。この消費されたシーケンスの後の最初の文字（もしあれば）は未読のままです。消費されたシーケンスの長さがゼロであるか、消費されたシーケンスを上記のように変換できない場合、マッチング失敗が発生します。ただし、ファイル終端、エンコードエラー、または読み取りエラーがストリームからの入力を妨げた場合は、入力失敗となります。 [、c、n 以外のすべての変換指定子は、解析を試みる前に、すべての連続する空白文字（isspace を呼び出した場合と同様に決定されます）を消費して破棄します。これらの消費された文字は、指定された最大フィールド幅にはカウントされません。 lc、ls、l[ の変換指定子は、最初の文字が変換される前にゼロに初期化された mbstate_t オブジェクトを使用して、mbrtowc を呼び出すようなマルチバイトからワイド文字への変換を行います。 s および [ 変換指定子は、マッチした文字に加えて常にヌル終端文字を格納します。宛先配列のサイズは、指定されたフィールド幅よりも少なくとも1つ大きくなければなりません。宛先配列のサイズを指定せずに %s または %[ を使用することは、gets と同様に安全ではありません。固定幅整数型（int8_t など）の正しい変換指定は、ヘッダ `<inttypes.h>` で定義されています（ただし、`SCNdMAX`、`SCNuMAX` などは %jd、%ju などと同義です）。各変換指定子の動作の後にシーケンスポイントがあります。これにより、複数のフィールドを同じ「シンク」変数に格納できます。指数部分に数字がなく、不完全な浮動小数点値を解析する場合（例：変換指定子 %f で "100er" を解析する）、シーケンス "100e"（有効な可能性のある浮動小数点数の最長プレフィックス）が消費され、マッチングエラー（消費されたシーケンスは浮動小数点数に変換できない）が発生し、"r" が残ります。一部の実装ではこの規則に従わず、"100" のみを消費するようにロールバックし、"er" を残します。例：glibc バグ 1765。変換指定子が不正な場合、動作は未定義です。

変換指定子が不正な場合、動作は未定義です。

[編集] 戻り値

1-3) 正常に代入された受信引数の数（最初の受信引数が代入される前にマッチングエラーが発生した場合、ゼロになることがあります）、または最初の受信引数が代入される前に発生した入力エラーの場合は EOF。

4-6) (1-3) と同様ですが、実行時制約違反がある場合にも EOF が返されます。

[編集] 計算量

保証されません。特に、sscanf の一部の実装は $O(N)$ であり、ここで N = strlen(buffer) です [1]。

[編集] 注記

ほとんどの変換指定子は最初に連続する空白をすべて消費するため、次のようなコードは

scanf("%d", &a);
scanf("%d", &b);

異なる行に入力された（最初の %d が残した改行を2番目の %d が消費します）または、スペースやタブで区切られた同じ行に入力された2つの整数を読み込みます（2番目の %d がスペースやタブを消費します）。

先頭の空白を消費しない変換指定子（例：%c）は、フォーマット文字列に空白文字を使用することで、それを消費させることができます。

scanf("%d", &a);
scanf(" %c", &c); // consume all consecutive whitespace after %d, then read a char

[編集] 例

このコードを実行

#define __STDC_WANT_LIB_EXT1__ 1
#include <stdio.h>
#include <stddef.h>
#include <locale.h>
 
int main(void)
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    setlocale(LC_ALL, "en_US.utf8");
 
    char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水";
    /* parse as follows:
       %d: an integer
       %f: a floating-point value
       %9s: a string of at most 9 non-whitespace characters
       %2d: two-digit integer (digits 5 and 6)
       %f:  a floating-point value (digits 7, 8, 9)
       %*d: an integer which isn't stored anywhere
       ' ': all consecutive whitespace
       %3[0-9]: a string of at most 3 decimal digits (digits 5 and 6)
       %2lc: two wide characters, using multibyte to wide conversion  */
    int ret = sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                     &i, &x, str1, &j, &y, str2, warr);
 
    printf("Converted %d fields:\n"
           "i = %d\n"
           "x = %f\n"
           "str1 = %s\n"
           "j = %d\n"
           "y = %f\n"
           "str2 = %s\n"
           "warr[0] = U+%x\n"
           "warr[1] = U+%x\n",
           ret, i, x, str1, j, y, str2, warr[0], warr[1]);
 
#ifdef __STDC_LIB_EXT1__
    int n = sscanf_s(input, "%d%f%s", &i, &x, str1, (rsize_t)sizeof str1);
    // writes 25 to i, 5.432 to x, the 9 bytes "Thompson\0" to str1, and 3 to n.
#endif
}

実行結果の例

Converted 7 fields:
i = 25
x = 5.432000
str1 = Thompson
j = 56
y = 789.000000
str2 = 56
warr[0] = U+df
warr[1] = U+6c34

[編集] 参考文献

C17標準 (ISO/IEC 9899:2018)

7.21.6.2 The fscanf function (p: 231-236)

7.21.6.4 The scanf function (p: 236-237)

7.21.6.7 The sscanf function (p: 238-239)

K.3.5.3.2 The fscanf_s function (p: 430-431)

K.3.5.3.4 The scanf_s function (p: 432)

K.3.5.3.7 The sscanf_s function (p: 433)

C11標準 (ISO/IEC 9899:2011)

7.21.6.2 The fscanf function (p: 317-324)

7.21.6.4 The scanf function (p: 325)

7.21.6.7 The sscanf function (p: 326)

K.3.5.3.2 The fscanf_s function (p: 592-593)

K.3.5.3.4 The scanf_s function (p: 594)

K.3.5.3.7 The sscanf_s function (p: 596)

C99標準 (ISO/IEC 9899:1999)

7.19.6.2 The fscanf function (p: 282-289)

7.19.6.4 The scanf function (p: 290)

7.19.6.7 The sscanf function (p: 291)

C89/C90標準 (ISO/IEC 9899:1990)

4.9.6.2 The fscanf function

4.9.6.4 The scanf function

4.9.6.6 The sscanf function

[編集] 関連項目

vscanfvfscanfvsscanfvscanf_svfscanf_svsscanf_s (C99)(C99)(C99)(C11)(C11)(C11)	stdin、ファイルストリーム、またはバッファから書式化された入力を読み込む可変長引数リストを使用する (関数) [編集]
fgets	ファイルストリームから文字列を取得する (関数) [編集]
printffprintfsprintfsnprintfprintf_sfprintf_ssprintf_ssnprintf_s (C99)(C11)(C11)(C11)(C11)	stdout、ファイルストリーム、またはバッファに書式化された出力を書き出す (関数) [編集]
C++ ドキュメント (scanf, fscanf, sscanf)

コンパイラサポート
言語
ヘッダー
型サポート
プログラムユーティリティ
可変長引数関数のサポート
エラーハンドリング
動的メモリ管理
文字列ライブラリ
アルゴリズム
数値
日付と時刻のユーティリティ
入出力サポート
ローカライゼーションサポート
並行処理サポート (C11)
技術仕様
シンボルインデックス

cppreference.com

名前空間

変種

表示

操作