sscanf、_sscanf_l、swscanf、_swscanf_l

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

更新 : 2007 年 11 月

文字列から書式付きデータを読み込みます。これらの関数のセキュリティを強化したバージョンについては、「sscanf_s、_sscanf_s_l、swscanf_s、_swscanf_s_l」を参照してください。

int sscanf(
   const char *buffer,
   const char *format [,
      argument ] ... 
);
int _sscanf_l(
   const char *buffer,
   const char *format,
   locale_t locale [,
      argument ] ... 
);
int swscanf(
   const wchar_t *buffer,
   const wchar_t *format [,
      argument ] ... 
);
int _swscanf_l(
   const wchar_t *buffer,
   const wchar_t *format,
   locale_t locale [,
      argument ] ... 
);

パラメータ

buffer
格納されるデータ。
format
書式指定文字列。詳細については、「scanf 関数と wscanf 関数の書式指定フィールド」を参照してください。
argument
省略可能な引数。
locale
使用するロケール。

戻り値

これらの関数は、正常に変換および代入されたフィールドの数を返します。読み込まれただけで代入されなかったフィールドは戻り値には含まれません。戻り値が 0 の場合は、代入されたフィールドがなかったことを示します。エラーが発生するか、最初の変換前に文字列の終端に達した場合は EOF が返されます。

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

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

解説

sscanf 関数は、buffer からのデータを各 argument で指定した位置に読み込みます。各 argument には、format の型指定子に対応する型を持つ変数へのポインタを指定する必要があります。引数 format は、入力フィールドの解釈を制御し、scanf 関数の引数 format と同じ形式と機能を持ちます。重なり合う文字列間でコピーした場合の動作は未定義です。

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

swscanf は sscanf のワイド文字バージョンであり、swscanf の引数はワイド文字列です。sscanf はマルチバイトの 16 進文字を処理しません。swscanf は Unicode の全角 16 進文字も "互換区域" の文字も処理しません。それ以外では、swscanf と sscanf の動作は同じです。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_stscanf	sscanf	sscanf	swscanf
_stscanf_l	_sscanf_l	_sscanf_l	_swscanf_l

必要条件

ルーチン	必須ヘッダー
sscanf, _sscanf_l	<stdio.h>
swscanf, _swscanf_l	<stdio.h> または <wchar.h>

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

使用例

// crt_sscanf.c
// compile with: /W3
// This program uses sscanf to read data items
// from a string named tokenstring, then displays them.

#include <stdio.h>

int main( void )
{
   char  tokenstring[] = "15 12 14...";
   char  s[81];
   char  c;
   int   i;
   float fp;

   // Input various data from tokenstring:
   // max 80 character string:
   sscanf( tokenstring, "%80s", s ); // C4996
   sscanf( tokenstring, "%c", &c );  // C4996
   sscanf( tokenstring, "%d", &i );  // C4996
   sscanf( tokenstring, "%f", &fp ); // C4996
   // Note: sscanf is deprecated; consider using sscanf_s instead

   // Output the data read
   printf( "String    = %s\n", s );
   printf( "Character = %c\n", c );
   printf( "Integer:  = %d\n", i );
   printf( "Real:     = %f\n", fp );
}

String    = 15
Character = 1
Integer:  = 15
Real:     = 15.000000