sscanf_s、_sscanf_s_l、swscanf_s、_swscanf_s_l

[アーティクル]
06/09/2015

文字列から書式付きデータを読み込みます。 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
書式指定文字列。詳細については、「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, _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, _countof(c)); // not null terminated

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

注意

サイズパラメーターは size_t 型ではなく、unsigned 型です。

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

swscanf_s は sscanf_s; のワイド文字バージョンであり、swscanf_s の引数はワイド文字列です。 sscanf_s は、マルチバイトの 16 進文字を処理しません。 swscanf_s は、Unicode の全角 16 進文字や "互換区域" の文字は処理しません。それ以外では、swscanf_s と sscanf_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, _countof(s) );
   sscanf_s( tokenstring, "%c", &c, 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 );
}

同等の .NET Framework 関数

System::Double::Parse などの Parse メソッドを参照してください。

次の方法で共有

sscanf_s、_sscanf_s_l、swscanf_s、_swscanf_s_l

パラメーター

戻り値

解説

必要条件

使用例

同等の .NET Framework 関数

参照

関連項目

その他のリソース