fscanf_s、 _fscanf_s_l、 fwscanf_s、 _fwscanf_s_l

ストリームから書式化されたデータを読み出します。 これらのバージョンの fscanf、 _fscanf_l、 fwscanf、 _fwscanf_l には、CRT の セキュリティ機能の説明に従ってセキュリティが強化。

構文

int fscanf_s(
   FILE *stream,
   const char *format [,
   argument ]...
);
int _fscanf_s_l(
   FILE *stream,
   const char *format,
   _locale_t locale [,
   argument ]...
);
int fwscanf_s(
   FILE *stream,
   const wchar_t *format [,
   argument ]...
);
int _fwscanf_s_l(
   FILE *stream,
   const wchar_t *format,
   _locale_t locale [,
   argument ]...
);

パラメーター

stream
FILE 構造体へのポインター。

format
書式指定文字列。

argument
省略可能な引数。

locale
使用するロケール。

戻り値

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

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

解説

fscanf_s 関数は、stream の現在位置から argument (ある場合) で指定された位置にデータを読み込みます。 各 argument は、format の型指定子に対応する型の変数へのポインターにする必要があります。 formatは、入力フィールドの解釈を制御し、scanf_sのformat引数と同じ形式と機能を持ちます。formatの説明については、「Format の仕様フィールド: scanfおよびwscanf関数を参照してください。 fwscanf_s 関数は、fscanf_s 関数のワイド文字バージョンです。fwscanf_s の format 引数は、ワイド文字列です。 ストリームが ANSI モードで開かれている場合、これらの関数の動作は同じになります。 fscanf_s では、UNICODE ストリームからの入力はサポートされていません。

セキュリティが強化された関数 (_s サフィックス付き) とその他のバージョンの関数との主な違いは、セキュリティが強化された関数では、c、C、s、S、および [ の各型フィールドを使用するとき、引数として、それぞれの変数の直後にフィールドのサイズを渡す必要がある点です。 詳細については、「scanf_s、_scanf_s_l、wscanf_s、_wscanf_s_l」と「scanf 関数の幅指定」を参照してください。

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

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

要件

互換性の詳細については、「 Compatibility」を参照してください。

例

// crt_fscanf_s.c
// This program writes formatted
// data to a file. It then uses fscanf to
// read the various data back from the file.

#include <stdio.h>
#include <stdlib.h>

FILE *stream;

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

   errno_t err = fopen_s( &stream, "fscanf.out", "w+" );
   if( err )
      printf_s( "The file fscanf.out was not opened\n" );
   else
   {
      fprintf_s( stream, "%s %ld %f%c", "a-string",
               65000, 3.14159, 'x' );
      // Set pointer to beginning of file:
      fseek( stream, 0L, SEEK_SET );

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

      fscanf_s( stream, "%f", &fp );
      fscanf_s( stream, "%c", &c, 1 );

      // 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

関連項目

ストリーム入出力
_cscanf_s、 _cscanf_s_l、 _cwscanf_s、 _cwscanf_s_l
fprintf_s、 _fprintf_s_l、 fwprintf_s、 _fwprintf_s_l
scanf_s、 _scanf_s_l、 wscanf_s、 _wscanf_s_l
sscanf_s、 _sscanf_s_l、 swscanf_s、 _swscanf_s_l
fscanf、 _fscanf_l、 fwscanf、 _fwscanf_l