scanf

scanf（スキャンエフ）は、C言語げんごの標準ひょうじゅん関数かんすう。ヘッダーファイル stdio.h で定義ていぎされている、書式しょしき付つき入力にゅうりょく関数かんすうである。

標準ひょうじゅん入力にゅうりょく（大抵たいていはキーボード）からの入力にゅうりょくを、書式しょしきに従したがって変数へんすうに読よみ込こむ機能きのうを持もつ。標準ひょうじゅん出力しゅつりょく関数かんすうのprintfと対比たいひさせて考かんがえると分わかりやすい。

ユーザーからの入力にゅうりょくを受うける、ごく基本きほん的てきな機能きのうを持もつにもかかわらず、後述こうじゅつするように異常いじょう入力にゅうりょく（エラー）に配慮はいりょすると相応そうおうの手間てまがかかるため、テストプログラムや入門にゅうもん書しょを除のぞいてはあまり使つかわれない。

このファミリーの関数かんすうには、入力にゅうりょくストリームを指定していできる fscanf や、メモリ上じょうの文字もじ列れつストリームを入力にゅうりょく対象たいしょうとする sscanf などがある。

形式けいしき

stdio.h内ないで以下いかの様ように宣言せんげんされている。

int scanf(const char *format, ...);

printf と同様どうよう、第だい1引数ひきすうのformatは、それに続つづく可変長かへんちょうの実じつ引数ひきすうの変換へんかん方法ほうほう（書式しょしき）を指定していする。また戻もどり値ちは入力にゅうりょく（スキャン）に成功せいこうした入力にゅうりょく項目こうもくの数かずが返かえされる。

利用りよう例れいを以下いかに示しめす。

#include <stdio.h>

int main(void)
{
  int x; /* スキャン結果けっかを格納かくのうする変数へんすう。 */

  printf("x = ? "); /* 入力にゅうりょくを促うながすプロンプト。 */
  /* スキャンと結果けっかの確認かくにん。 */
  if (scanf("%d", &x) == 1) {
    printf("スキャン結果けっか = %d\n", x);
  }
  else {
    printf("スキャン失敗しっぱい\n");
  }
  return 0;
}

変換へんかん指定してい

scanf の変換へんかん指定していは次つぎの形式けいしきをとる。

% [代入だいにゅう抑止よくし][最大さいだいフィールド幅はば][長ながさ修飾しゅうしょく子こ]変換へんかん指定してい子こ

代入だいにゅう抑止よくし

フラグ	意味いみ
*	フォーマットに合あわせて入力にゅうりょくを読よみ込こむが実じつ引数ひきすうに代入だいにゅうはされない。

例たとえば

char c;
scanf("%*c%c", &c);

というコードがあり、 "ab"という入力にゅうりょくがあった場合ばあい 1文字もじ目めの 'a' は無視むしされ 2文字もじ目めの 'b' という文字もじが代入だいにゅうされる。

長ながさ修飾しゅうしょく子こ

修飾しゅうしょく子こ	意味いみ	導入どうにゅうバージョン
hh	実じつ引数ひきすうは char 型がた	C99以降いこう
h	実じつ引数ひきすうは short 型がた	全ぜんバージョン
l（エル）	実じつ引数ひきすうは long 型がたまたは wchar_t 型かたまたは double 型がた	wchar_t についてはC95以降いこう
ll（エルエル）	実じつ引数ひきすうは long long 型がた	C99以降いこう
j	実じつ引数ひきすうは intmax_t 型がた	C99以降いこう
z	実じつ引数ひきすうは size_t 型がた	C99以降いこう
t	実じつ引数ひきすうは ptrdiff_t 型がた	C99以降いこう
L	実じつ引数ひきすうは long double 型がた	全ぜんバージョン

変換へんかん指定してい子こ

指定してい子こ	意味いみ	導入どうにゅうバージョン
d,i	10進しん符号ふごう付つき整数せいすう	全ぜんバージョン
u	10進しん符号ふごう無なし整数せいすう	全ぜんバージョン
o	8進しん符号ふごう無なし整数せいすう	全ぜんバージョン
x,X	16進しん符号ふごう無なし整数せいすう	全ぜんバージョン
e,E	浮動ふどう小数点しょうすうてん数すう	全ぜんバージョン
f,F	浮動ふどう小数点しょうすうてん数すう	全ぜんバージョン
g,G	浮動ふどう小数点しょうすうてん数すう	全ぜんバージョン
a,A	浮動ふどう小数点しょうすうてん数すう	C99以降いこう
c	文字もじ	全ぜんバージョン
s	文字もじ列れつ	全ぜんバージョン
p	ポインタの値ね、対応たいおうする引数ひきすうは void* になる。	全ぜんバージョン
n	整数せいすう変数へんすうに出力しゅつりょく済ずみ文字数もじすうを格納かくのう	全ぜんバージョン
%	'%'の入力にゅうりょく	全ぜんバージョン
[...]	[ ]内ないで囲かこまれた文字もじだけを取得しゅとくし、それ以外いがいの文字もじが現あらわれた場所ばしょ以降いこうは入力にゅうりょくを終了しゅうりょうする（下記かき参照さんしょう）。	全ぜんバージョン

[ ] は例たとえば

char str[256];
scanf("%[abc]", str);

というコードがあり、入力にゅうりょくに "babaacdeabfghijabcef" という文字もじ列れつが入はいった場合ばあい、str には "babaac" という文字もじ列れつのみが入力にゅうりょくされ、残のこりの文字もじ列れつは入力にゅうりょくされずに終了しゅうりょうする。strに代入だいにゅうされなかった、"deabfghijabcef"は入力にゅうりょくストリームに残のこる形かたちとなる。また[^ ... ]とした場合ばあいは逆ぎゃくに[ ]内ないの文字もじが入はいってくるまで文字もじを読よみ込こむ。例たとえば、

char str[256];
scanf("%[^abc]", str);

という場合ばあい、"ghetbceajk"と入力にゅうりょくすると、str には"ghet"が代入だいにゅうされる。上記じょうきと同様どうように、入力にゅうりょくされなかった文字もじ列れつは入力にゅうりょくストリームに保持ほじされる。

コード例れい

ソース:

#include <stdio.h>
#include <limits.h>

int main(void)
{
  int n1, n2, nadd, nsub, nmul, ndiv, nmod;

  printf("1つ目めの入力にゅうりょく数値すうち:");
  if (scanf("%d", &n1) != 1) {
    puts("スキャン失敗しっぱい");
    return -1;
  }
  printf("2つ目めの入力にゅうりょく数値すうち:");
  if (scanf("%d", &n2) != 1) {
    puts("スキャン失敗しっぱい");
    return -1;
  }
  if (n2 == 0) {
    /* ゼロ除算じょざん防止ぼうしのチェック。 */
    puts("2つ目めの数値すうちは非ひゼロを入力にゅうりょくしてください");
    return -1;
  }
  if (n1 == INT_MIN && n2 == -1) {
    /* 除算じょざんと剰余じょうよのオーバーフローエラー防止ぼうしのチェック。 */
    puts("オーバーフローしない数値すうちの組くみ合あわせを入力にゅうりょくしてください");
    return -1;
  }

  nadd = n1 + n2;
  nsub = n1 - n2;
  nmul = n1 * n2;
  ndiv = n1 / n2;
  nmod = n1 % n2;

  printf("%d + %d = %d\n", n1, n2, nadd);
  printf("%d - %d = %d\n", n1, n2, nsub);
  printf("%d * %d = %d\n", n1, n2, nmul);
  printf("%d / %d = %d + %d / %d\n", n1, n2, ndiv, nmod, n2);

  return 0;
}

出力しゅつりょく結果けっかの例れい:

1つ目めの入力にゅうりょく数値すうち:60
2つ目めの入力にゅうりょく数値すうち:21
60 + 21 = 81
60 - 21 = 39
60 * 21 = 1260
60 / 21 = 2 + 18 / 21

scanfの問題もんだい点てんと回避かいひ方法ほうほう

scanf は非常ひじょうに簡潔かんけつに入力にゅうりょくの制御せいぎょが行おこなえるため、C言語げんごの入門にゅうもん書しょでは必かならずと言いっていいほど登場とうじょうする。しかしこの関数かんすうにはいくつかの問題もんだい点てんが指摘してきされている。ここではよく指摘してきされる scanf の問題もんだい点てんとその回避かいひ方法ほうほうについて宣せんべる。

改行かいぎょう文字もじの取とり扱あつかい

入力にゅうりょくが文字もじ（char）の場合ばあい、主おもにキーボードで入力にゅうりょくの際さいに押おされるリターンキーが無視むしできないという問題もんだい点てんがある。例たとえば

char a, b, c;
scanf("%c", &a);
scanf("%c", &b);
scanf("%c", &c);

とした場合ばあい、通常つうじょうなら3回かい入力にゅうりょく待まちが行おこなわれることが期待きたいされていると思おもわれるが、実際じっさいには2回かいしか行おこなわれない（予期よきしない入力にゅうりょくはここでは考慮こうりょしない）。これは最初さいしょの a の入力にゅうりょくには入力にゅうりょくされた文字もじが代入だいにゅうされるが、このときストリーム上うえに改行かいぎょうコードが残のこされてしまい、次つぎの b には a を入力にゅうりょくする際さいに押下おうかされたリターンキーの改行かいぎょうコードが代入だいにゅうされるためである。通常つうじょうの %d や %s の場合ばあい改行かいぎょうコードは無視むしして入力にゅうりょくを読よみ込こむので問題もんだいにはならないが、 %c の場合ばあいは無条件むじょうけんにストリーム上じょうの次つぎのバイトを返かえすためこのような現象げんしょうが発生はっせいする。これを防ふせぐには、

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

のように最初さいしょに空白くうはくを入いれることで回避かいひされる。これは入力にゅうりょく前まえに空白くうはく（改行かいぎょうコードも含ふくむ）を読よみ飛とばすことを意味いみしている。ただしこの場合ばあい a, b, c に半角はんかくスペースを代入だいにゅうすることはできない。そのような場合ばあいとしては

scanf("%c%*c", &a);
scanf("%c%*c", &b);
scanf("%c%*c", &c);

という方法ほうほうがとられる。これは入力にゅうりょくした際さいの改行かいぎょう文字もじを%*cで除去じょきょすることを意味いみする。

空白くうはく、タブの読よみ飛とばし

scanf は空白くうはくとタブは改行かいぎょう文字もじと同おなじ区切くぎり文字もじとして扱あつかわれる。例たとえば、

char a[20];
scanf("%s", a);

という方法ほうほうで文字もじ列れつを読よみ込こもうとしたとする。このとき入力にゅうりょく文字もじ列れつが "This is a pen" というものだった場合ばあい、実じつ引数ひきすうに入力にゅうりょくされるものは "This" までである。これだけでも問題もんだいであるが、さらに問題もんだいなのは、残のこりの " is a pen" という文字もじ列れつはストリーム上じょうに残のこされてしまうことである。このため次つぎに scanf を呼よんだ場合ばあい、入力にゅうりょくにかかわらず実じつ引数ひきすうに "is" という文字もじ列れつを代入だいにゅうしようとしてしまうことになる。これを防ふせぐ手段しゅだんとしては

scanf("%[^\n]", a);

という方法ほうほうがとられる。この場合ばあいは改行かいぎょう文字もじ以外いがいの文字もじ列れつを全すべて a に代入だいにゅうするため、a には空白くうはくやタブも含ふくめて文字もじ列れつが代入だいにゅうされる。なお前述ぜんじゅつにおける入力にゅうりょく時じの改行かいぎょうコードの取とり扱あつかいも考慮こうりょした場合ばあいは、

scanf("%[^\n]%*c", a);

という記述きじゅつになる。

バッファオーバーラン

他たの C言語げんごの文字もじ列れつ処理しょり関数かんすうと同様どうように、scanf を使用しようする際さいにもバッファオーバーランが発生はっせいする可能かのう性せいがある^[1]。例たとえば

char a[20];
scanf("%s", a);

というコードがあった場合ばあい、a に入力にゅうりょくできる文字もじ列れつは終了しゅうりょう文字もじを除のぞく、19バイトまでしか入力にゅうりょくすることが出来できず、それ以上いじょうの文字もじ列れつが入力にゅうりょくされるとバッファオーバーランが発生はっせいする。a の領域りょういきが十分じゅうぶんであれば問題もんだいはないが、しかし入力にゅうりょくされてくる文字もじ列れつの長ながさを予測よそくすることは不可能ふかのうであり、結局けっきょく a の長ながさをいくら大おおきくしても、さらにそれを上回うわまわる長ながさの入力にゅうりょくが行おこなわれてしまえばバッファオーバーランが発生はっせいしてしまう危険きけん性せいがある。この問題もんだいを防ふせぐ手段しゅだんとして一般いっぱん的てきなのは最大さいだいフィールド幅はばを指定していすることである。上記じょうきの例れいの場合ばあいは

char a[20];
scanf("%19s", a);

とすることで、aには最初さいしょの19バイトが読よみ込こまれ入力にゅうりょくを終了しゅうりょうする。ただしこの場合ばあいは残のこりの文字もじ列れつはストリーム上じょうに残のこってしまうので実際じっさいには以下いかのようにすることで対処たいしょされる。

char a[20];
scanf("%19s%*[^\n]", a);

これは19バイト読よみ込こみさらに改行かいぎょう文字もじまでの文字もじ列れつを空そら読よみすることを意味いみする。

さらに前述ぜんじゅつの改行かいぎょうコードがストリームに残のこる問題もんだいを考慮こうりょすると

char a[20];
scanf("%19s%*[^\n]%*c", a);

となるが、この場合ばあいはaに入はいる文字もじ列れつが 19バイト以下いかの場合ばあいには、入力にゅうりょくストリームにやはり改行かいぎょう文字もじが残のこる。よって実際じっさいには、

char a[20];
scanf("%19s%*[^\n]", a);
getchar();

のように入力にゅうりょく終了しゅうりょう後ご、改行かいぎょう文字もじを空そら読よみするなどの方法ほうほうがとられる。空白くうはく文字もじの取とり扱あつかいも考慮こうりょする場合ばあい

char a[20];
scanf("%19[^\n]%*[^\n]", a);
getchar();

となる。

バージョン8.0 (2005) 以降いこうのMicrosoft Visual C++コンパイラには、scanf_s() という関数かんすうが用意よういされていて、バッファのサイズを指定していすることができる。scanf_s はC11規格きかくで標準ひょうじゅん化かされたが、実装じっそうは任意にんいである。

異常いじょうな入力にゅうりょくが行おこなわれた時ときの処理しょり

scanf関数かんすうは、予期よきせぬ値ねが入力にゅうりょくされると、その値ねを読よみ込こまず、ストリーム上うえに残のこしてしまう。例たとえば

int i;
scanf("%d", &i);

としたコードがあった場合ばあい、入力にゅうりょくが数字すうじでなかった場合ばあいは scanf はストリームにその文字もじ列れつを残のこしたまま終了しゅうりょうすることになる。このため次つぎに scanf が呼よばれたときはそのストリーム上じょうのバッファが実じつ引数ひきすうに代入だいにゅうされ、他たの scanf にも異常いじょうな結果けっかを返かえすことになる。例れいとして 1 が入力にゅうりょくされたら終了しゅうりょう、それ以外いがいはもう一度いちど入力にゅうりょくを求もとめるようなプログラムを考かんがえてみる、もしこのプログラムを

int i;
while(1) {
  scanf("%d", &i);
  if (i == 1) {
     break;
  }
}

というようなコードで記述きじゅつした場合ばあい、数字すうじ以外いがいの文字もじを入力にゅうりょくしてしまうと無限むげんループに陥おちいることになる。このような現象げんしょうを防ふせぐ手段しゅだんとして scanf の戻もどり値ちを利用りようする方法ほうほうがとられる。これは scanf は代入だいにゅうに成功せいこうした変数へんすうの数かずを戻もどり値ちとして返かえすため、指定していした実じつ引数ひきすうの数かずと scanf の戻もどり値ちが一致いっちしないときに入力にゅうりょくバッファをクリアすることで回避かいひできる。例たとえば上記じょうきの例れいの場合ばあいは以下いかのようになる。

int i;
while(1) { 
  if (scanf("%d", &i) != 1) {
     scanf("%*s");
     if (feof(stdin)) {
       /* エラー処理しょり */
     }
     continue;
  }

  if (i == 1) {
     break;
  }
}

入力にゅうりょくバッファのクリアはここでは文字もじ列れつを空そら読よみすることで実現じつげんしている（入力にゅうりょくバッファのクリア方法ほうほうは状況じょうきょうによって異ことなる方法ほうほうが考かんがえられる）。なお主おもにウェブ上じょうなどで、標準ひょうじゅん入力にゅうりょくのバッファクリアの方法ほうほうに fflush(stdin) や rewind(stdin) とする方法ほうほうが紹介しょうかいされることがあるが、ANSI規格きかくではこれらの動作どうさは未定義みていぎであり、正ただしい動作どうさを保障ほしょうするものではない。

この方法ほうほうでエラー処理しょりをする場合ばあいには上記じょうきの空白くうはく文字もじの取とり扱あつかいの関連かんれんで問題もんだいになることがある。例たとえば

int i, j;
scanf("%d %d", &i, &j);

のようなコードで、異常いじょうな入力にゅうりょくがあった場合ばあいエラー処理しょりをしたいとする。これを

int i, j;
if (scanf("%d %d", &i, &j) != 2) {
  エラー処理しょり
}

という方法ほうほうで実現じつげんすると入力にゅうりょくが "1" のみの場合ばあい、空白くうはくと改行かいぎょうは同一どういつ視しされてしまうため、変数へんすう "i" に 1 を入力にゅうりょくして後ご、変数へんすう "j"の入力にゅうりょく待まち状態じょうたいとなる。もし、このような場合ばあいにもエラー処理しょりを実行じっこうしたい場合ばあいには、例たとえば以下いかのように一度いちど文字もじ列れつとして読よみ込こんで、その後ご sscanf で読よみ込こむことで実装じっそうすればよい。

char a[20];
int i, j;

scanf("%19[^\n]%*[^\n]", a);
getchar();

if (sscanf(a, "%d %d", &i, &j) != 2) {
  エラー処理しょり
}

脚注きゃくちゅう

^ “[迷信めいしん] scanf ではバッファオーバーランを防ふせげない”. C/C++迷信めいしん集しゅう. 株式会社かぶしきがいしゃきじねこ. 2010年ねん2月がつ28日にち閲覧えつらん。 “書式しょしき指定していが不適切ふてきせつなために発生はっせいする脆弱ぜいじゃく性せいであって、scanf の問題もんだいではありません。”