scanf_s、_scanf_s_l、wscanf_s、_wscanf_s_l

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

更新 : 2007 年 11 月

標準入力ストリームから書式付きデータを読み取ります。これらの関数は、「CRT のセキュリティ強化」に説明されているように、scanf、_scanf_l、wscanf、_wscanf_l のセキュリティが強化されたバージョンです。

int scanf_s(
   const char *format [,
      argument]... 
);
int _scanf_s_l(
   const char *format,
   locale_t locale [,
      argument]... 
);
int wscanf_s(
   const wchar_t *format [,
      argument]... 
);
int _wscanf_s_l(
   const wchar_t *format,
   locale_t locale [,
      argument]... 
);

パラメータ

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

戻り値

正常に変換され、代入されたフィールドの数を返します。この数には、読み取られても代入されなかったフィールドは含まれません。戻り値が 0 の場合は、代入されたフィールドがなかったことを示します。エラーが発生した場合や、まだ文字を読み取っていないときにファイルの終端文字または文字列の終端文字が検出された場合は、EOF (end-of-file) を返します。format が NULL ポインタの場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラが呼び出されます。実行の継続が許可された場合、scanf_s および wscanf_s は EOF を返し、errno を EINVAL に設定します。

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

解説

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

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

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

scanf および wscanf とは異なり、scanf_s および wscanf_s では、c、C、s、S、または [ の型のすべての入力パラメータに対してバッファサイズを指定する必要があります。バッファサイズは、バッファまたは変数のポインタの直後に追加パラメータとして渡されます。たとえば、文字列を読み込む場合、その文字列のバッファサイズは次のように渡されます。

char s[10];

scanf("%9s", s, 10);

バッファサイズには、終端 null も含まれます。読み取られたトークンがバッファに確実に収まるように、幅指定フィールドが使用される場合もあります。幅指定フィールドが使用されない場合で、読み込まれたトークンがバッファに収まらない場合、そのバッファには何も書き込まれません。

メモ :
サイズパラメータは size_t 型ではなく、unsigned 型です。

文字の場合、次のように 1 文字読み込む場合もあります。

char c;

scanf("%c", &c, 1);

null で終わらない文字列に対して複数の文字列を読み込む場合、幅指定とバッファサイズとして整数が使用されます。

char c[4];

scanf("%4c", &c, 4); // not null terminated

詳細については、「scanf 関数の文字幅指定」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tscanf_s	scanf_s	scanf_s	wscanf_s
_tscanf_s_l	_scanf_s_l	_scanf_s_l	_wscanf_s_l

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

必要条件

ルーチン	必須ヘッダー
scanf_s, _scanf_s_l	<stdio.h>
wscanf_s, _wscanf_s_l	<stdio.h> または <wchar.h>

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

使用例

// crt_scanf_s.c
// This program uses the scanf_s and wscanf_s 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_s( "%d %f %c %C %s %S", &i, &fp, &c, 1,
                     &wc, 1, s, 80, ws, 80 );
   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_s( L"%d %f %hc %lc %S %ls", &i, &fp, &c, 2,
                      &wc, 1, s, 80, ws, 80 );
   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