fscanf、_fscanf_l、fwscanf、_fwscanf_l

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

更新 : 2007 年 11 月

ストリームから書式化されたデータを読み出します。これらの関数のセキュリティを強化したバージョンについては、「fscanf_s、_fscanf_s_l、fwscanf_s、_fwscanf_s_l」を参照してください。

int fscanf( 
   FILE *stream,
   const char *format [,
      argument ]... 
);
int _fscanf_l( 
   FILE *stream,
   const char *format,
   locale_t locale [,
      argument ]... 
);
int fwscanf( 
   FILE *stream,
   const wchar_t *format [,
      argument ]... 
);
int _fwscanf_l( 
   FILE *stream,
   const wchar_t *format,
   locale_t locale [,
      argument ]... 
);

パラメータ

stream
FILE 構造体へのポインタ。
format
書式指定文字列。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

これらの関数は、正常に変換および代入されたフィールドの数を返します。読み込まれただけで代入されなかったフィールドは戻り値には含まれません。戻り値が 0 の場合は、代入されたフィールドがなかったことを示します。エラーが発生した場合や、最初の変換の前にファイルストリームの終端を検出した場合、fscanf および fwscanf は EOF を返します。

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

解説

fscanf 関数は、stream の現在位置から argument (ある場合) で指定された位置にデータを読み込みます。各 argument には、format で指定した型指定子に対応する型の変数へのポインタを指定する必要があります。format は、入力フィールドの解釈を制御し、形式および機能は scanf 関数の引数 format と同じです。format の詳細については、「scanf」を参照してください。

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_ftscanf	fscanf	fscanf	fwscanf
_ftscanf_l	_fscanf_l	_fscanf_l	_fwscanf_l

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

必要条件

関数	必須ヘッダー
fscanf, _fscanf_l	<stdio.h>
fwscanf, _fwscanf_l	<stdio.h> または <wchar.h>

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

使用例

// crt_fscanf.c
// compile with: /W3
// This program writes formatted
// data to a file. It then uses fscanf to
// read the various data back from the file.
 
#include <stdio.h>

FILE *stream;

int main( void )
{
   long l;
   float fp;
   char s[81];
   char c;

   if( fopen_s( &stream, "fscanf.out", "w+" ) != 0 )
      printf( "The file fscanf.out was not opened\n" );
   else
   {
      fprintf( stream, "%s %ld %f%c", "a-string", 
               65000, 3.14159, 'x' );
      // Security caution!
      // Beware loading data from a file without confirming its size,
      // as it may lead to a buffer overrun situation.

      // Set pointer to beginning of file:
      fseek( stream, 0L, SEEK_SET );

      // Read data back from file:
      fscanf( stream, "%s", s );   // C4996
      fscanf( stream, "%ld", &l ); // C4996

      fscanf( stream, "%f", &fp ); // C4996
      fscanf( stream, "%c", &c );  // C4996
      // Note: fscanf is deprecated; consider using fscanf_s instead

      // Output data read: 
      printf( "%s\n", s );
      printf( "%ld\n", l );
      printf( "%f\n", fp );
      printf( "%c\n", c );

      fclose( stream );
   }
}

a-string
65000
3.141590
x