sscanf_s、 _sscanf_s_l、 swscanf_s、 _swscanf_s_l

文字列から書式付きデータを読み込みます。 これらのバージョンの sscanf、 _sscanf_l、 swscanf、 _swscanf_l には、CRT の セキュリティ機能の説明に従ってセキュリティが強化。

構文

int sscanf_s(
   const char *buffer,
   const char *format [,
   argument ] ...
);
int _sscanf_s_l(
   const char *buffer,
   const char *format,
   _locale_t locale [,
   argument ] ...
);
int swscanf_s(
   const wchar_t *buffer,
   const wchar_t *format [,
   argument ] ...
);
int _swscanf_s_l(
   const wchar_t *buffer,
   const wchar_t *format,
   _locale_t locale [,
   argument ] ...
);

パラメーター

buffer
格納されるデータ。

format
書式指定文字列。 詳細については、「 Format 仕様フィールド: scanf および wscanf 関数を参照してください。

argument
省略可能な引数。

locale
使用するロケール。

戻り値

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

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

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

解説

sscanf_s 関数は、buffer からのデータを各 argument で指定した位置に読み込みます。 書式指定文字列の後の引数には、format の型指定子に対応する型を持つ変数へのポインターを指定します。 より安全なバージョンである sscanf とは異なり、型フィールド文字 c、C、s、S、または [] で囲まれた文字列のコントロール セットを使用する場合にバッファー サイズのパラメーターが必要です。 文字単位のバッファー サイズは、それを必要とする各バッファー パラメーターの直後に追加のパラメーターとして指定する必要があります。 たとえば、文字列を読み取る場合、その文字列のバッファー サイズは次のように渡されます。

wchar_t ws[10];
swscanf_s(in_str, L"%9s", ws, (unsigned)_countof(ws)); // buffer size is 10, width specification is 9

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

1 文字は次のように読み取られます。

wchar_t wc;
swscanf_s(in_str, L"%c", &wc, 1);

次に、この例では、入力文字列とデータ ストアから 1 つの文字をワイド文字バッファーに読み込みます。 null で終わらない文字列に対して複数の文字列を読み込む場合、幅指定とバッファー サイズとして符号なし整数が使用されます。

char c[4];
sscanf_s(input, "%4c", &c, (unsigned)_countof(c)); // not null terminated

詳細については、 scanf_s、 _scanf_s_l、 wscanf_s、 _wscanf_s_l 、および scanf 型のフィールド文字を参照してください。

引数 format は、入力フィールドの解釈を制御し、format 関数の引数 scanf_s と同じ形式と機能を持ちます。 重なり合う文字列間でコピーした場合の動作は未定義です。

swscanf_s は sscanf_sのワイド文字バージョンであり、 swscanf_s の引数はワイド文字列です。 sscanf_s では、マルチバイトの 16 進数文字は処理されません。 swscanf_s では、Unicode の全角 16 進数または "互換性ゾーン" 文字は処理されません。 それ以外では、 swscanf_s と sscanf_s の動作は同じです。

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

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

要件

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

例

// crt_sscanf_s.c
// This program uses sscanf_s to read data items
// from a string named tokenstring, then displays them.

#include <stdio.h>
#include <stdlib.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 plus null terminator
   sscanf_s( tokenstring, "%s", s, (unsigned)_countof(s) );
   sscanf_s( tokenstring, "%c", &c, (unsigned)sizeof(char) );
   sscanf_s( tokenstring, "%d", &i );
   sscanf_s( tokenstring, "%f", &fp );

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

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

関連項目

ストリーム入出力
fscanf、 _fscanf_l、 fwscanf、 _fwscanf_l
scanf、 _scanf_l、 wscanf、 _wscanf_l
sprintf、 _sprintf_l、 swprintf、 _swprintf_l、 __swprintf_l
snprintf、 _snprintf、 _snprintf_l、 _snwprintf、 _snwprintf_l