scanf、_scanf_l、wscanf、_wscanf_l

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

標準入力ストリームから書式付きデータを読み取ります。これらの関数のセキュリティを強化したバージョンについては、「scanf_s、_scanf_s_l、wscanf_s、_wscanf_s_l」を参照してください。

int scanf(
   const char *format [,
      argument]... 
);
int _scanf_l(
   const char *format,
   locale_t locale [,
      argument]... 
);
int wscanf(
   const wchar_t *format [,
      argument]... 
);
int _wscanf_l(
   const wchar_t *format,
   locale_t locale [,
      argument]... 
);

パラメータ

format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

正常に変換され、代入されたフィールドの数を返します。この数には、読み取られても代入されなかったフィールドは含まれません。戻り値が 0 の場合は、代入されたフィールドがなかったことを示します。

format が NULL ポインタの場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラが呼び出されます。実行の継続が許可された場合、これらの関数は EOF を返し、errno を EINVAL に設定します。

エラーコードの詳細については、「_doserrno、errno、_sys_errlist、および _sys_nerr」を参照してください。

解説

scanf 関数は、標準入力ストリーム stdin からデータを読み取り、そのデータを argument で指定されている位置に書き込みます。各 argument は、format の型指定子に対応する型の変数へのポインタにする必要があります。重なり合う文字列間でコピーした場合の動作は未定義です。

セキュリティに関するメモ :
scanf で文字列を読み取る場合は、書式が %s の桁数を必ず指定してください。たとえば、"%s" ではなく、"%32s" と指定します。指定しなかった場合は、入力の書式が正しく指定されず、バッファオーバーランが発生しやすくなります。または、scanf_s、_scanf_s_l、wscanf_s、_wscanf_s_l または fgets の使用を検討してください。

scanf で文字列を読み取る場合は、書式が %s の桁数を必ず指定してください。たとえば、"%s" ではなく、"%32s" と指定します。指定しなかった場合は、入力の書式が正しく指定されず、バッファオーバーランが発生しやすくなります。または、scanf_s、_scanf_s_l、wscanf_s、_wscanf_s_l または fgets の使用を検討してください。

wscanf は scanf のワイド文字バージョンであり、wscanf の引数 format はワイド文字文字列です。ストリームが ANSI モードで開いている場合、wscanf と scanf の動作は同じです。現在 scanf では、UNICODE ストリームからの入力はサポートされていません。

これらの関数のうち _l サフィックスが付けられたバージョンは、現在のスレッドロケールの代わりに渡されたロケールパラメータを使用する点を除いて同じです。

汎用テキストルーチンのマップ

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tscanf	scanf	scanf	wscanf
_tscanf_l	_scanf_l	_scanf_l	_wscanf_l

詳細については、「scanf 関数と wscanf 関数の書式指定フィールド」を参照してください。

必要条件

ルーチン	必須ヘッダー
scanf, _scanf_l	<stdio.h>
wscanf, _wscanf_l	<stdio.h> または <wchar.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// crt_scanf.c
// compile with: /W3
 /* This program uses the scanf and wscanf functions
  * to read formatted input.
  */

#include <stdio.h>

int main( void )
{
   int   i, result;
   float fp;
   char  c, s[81];
   wchar_t wc, ws[81];
   result = scanf( "%d %f %c %C %80s %80S", &i, &fp, &c, &wc, s, ws ); // C4996
   // Note: scanf and wscanf are deprecated; consider using scanf_s and wscanf_s
   printf( "The number of fields input is %d\n", result );
   printf( "The contents are: %d %f %c %C %s %S\n", i, fp, c, wc, s, ws);
   result = wscanf( L"%d %f %hc %lc %80S %80ls", &i, &fp, &c, &wc, s, ws ); // C4996
   wprintf( L"The number of fields input is %d\n", result );
   wprintf( L"The contents are: %d %f %C %c %hs %s\n", i, fp, c, wc, s, ws);
}

71 98.6 h z Byte characters
36 92.3 y n Wide characters

The number of fields input is 6
The contents are: 71 98.599998 h z Byte characters
The number of fields input is 6
The contents are: 36 92.300003 y n Wide characters