sscanf_s, _sscanf_s_l, swscanf_s, _swscanf_s_l

文字列から書式付きデータを読み込みます。 sscanf_sscanf_lswscanf_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
書式指定文字列。 詳細については、「scanf 関数と wscanf 関数の書式指定フィールド」を参照してください。

argument
省略可能な引数。

locale
使用するロケール。

戻り値

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

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

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

解説

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

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_lwscanf_s_wscanf_s_l」および「scanf 関数の型フィールド文字」を参照してください。

Note

サイズ パラメーターは unsigned 型ではなく、size_t 型です。 64 ビット ターゲット用にコンパイルするときは、静的キャストを使用して _countof またはsizeof の結果を適切なサイズに変換します。

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

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

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

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

TCHAR.H ルーチン _UNICODE&_MBCS が定義されていない _MBCS が定義されている _UNICODE が定義されている
_stscanf_s sscanf_s sscanf_s swscanf_s
_stscanf_s_l _sscanf_s_l _sscanf_s_l _swscanf_s_l

必要条件

ルーチンによって返される値 必須ヘッダー
sscanf_s, _sscanf_s_l <stdio.h>
swscanf_s, _swscanf_s_l <stdio.h> または <wchar.h>

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

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