vscanf_s, vwscanf_s

標準入力ストリームから書式付きデータを読み取ります。 これらのバージョンのvscanfvwscanf、「CRT のセキュリティ機能説明されているように、セキュリティが強化。

構文

int vscanf_s(
   const char *format,
   va_list arglist
);
int vwscanf_s(
   const wchar_t *format,
   va_list arglist
);

パラメーター

format
書式指定文字列。

arglist
可変個引数リスト。

戻り値

正常に変換され、割り当てられたフィールドの数を返します。戻り値には、読み取られたが割り当てられないフィールドは含まれません。 戻り値が 0 の場合は、代入されたフィールドがなかったことを示します。 エラーが発生した場合や、まだ文字を読み取っていないときにファイルの終端文字または文字列の終端文字が検出された場合は、EOF (end-of-file) を返します。 formatがNULL ポインターの場合、「パラメーターの検証で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、vscanf_s および vwscanf_s は EOF を返し、errno を EINVAL に設定します。

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

解説

vscanf_s 関数は、標準入力ストリーム stdin からデータを読み取り、そのデータを arglist 引数リストで指定されている位置に書き込みます。 リストの各引数は、format の型指定子に対応する型の変数へのポインターにする必要があります。 重なり合う文字列間でコピーした場合の動作は未定義です。

vwscanf_s 関数は、 vscanf_s関数のワイド文字バージョンです。 format 関数の引数 vwscanf_s は、ワイド文字列です。 ストリームが ANSI モードで開かれている場合、vwscanf_s と vscanf_s の動作は同じになります。 vscanf_s では、UNICODE ストリームからの入力はサポートされていません。

vscanfとvwscanfとは異なり、vscanf_sおよびvwscanf_sでは、[]で囲まれたc、C、、S、または文字列コントロール セットのすべての入力パラメーターにバッファー サイズを指定する必要があります。 バッファー サイズは、バッファーまたは変数へのポインターの直後に別のパラメーターとして渡されます。 wchar_t文字列のバッファー サイズ (文字数) は、バイト単位のサイズと同じではありません。

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

詳細については、「scanf 関数の文字幅指定」を参照してください。

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

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

要件

ユニバーサル Windows プラットフォーム (UWP) アプリではコンソールがサポートされていません。 コンソール (stdin、stdout、stderr) に関連付けられている標準ストリームのハンドルは、C ランタイム関数によって UWP アプリで使用される前に、リダイレクトする必要があります。 互換性の詳細については、「 Compatibility」を参照してください。

例

// crt_vscanf_s.c
// compile with: /W3
// This program uses the vscanf_s and vwscanf_s functions
// to read formatted input.

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

int call_vscanf_s(char *format, ...)
{
    int result;
    va_list arglist;
    va_start(arglist, format);
    result = vscanf_s(format, arglist);
    va_end(arglist);
    return result;
}

int call_vwscanf_s(wchar_t *format, ...)
{
    int result;
    va_list arglist;
    va_start(arglist, format);
    result = vwscanf_s(format, arglist);
    va_end(arglist);
    return result;
}

int main( void )
{
    int   i, result;
    float fp;
    char  c, s[81];
    wchar_t wc, ws[81];
    result = call_vscanf_s("%d %f %c %C %s %S", &i, &fp, &c, 1,
                           &wc, 1, s, _countof(s), ws, _countof(ws) );
    printf( "The number of fields input is %d\n", result );
    printf( "The contents are: %d %f %c %C %s %S\n", i, fp, c, wc, s, ws);
    result = call_vwscanf_s(L"%d %f %hc %lc %S %ls", &i, &fp, &c, 2,
                            &wc, 1, s, _countof(s), ws, _countof(ws) );
    wprintf( L"The number of fields input is %d\n", result );
    wprintf( L"The contents are: %d %f %C %c %hs %s\n", i, fp, c, wc, s, ws);
}

このプログラムで、この例の入力を指定した場合、次の出力が生成されます。

71 98.6 h z Byte characters
36 92.3 y n Wide characters

The number of fields input is 6
The contents are: 71 98.599998 h z Byte characters
The number of fields input is 6
The contents are: 36 92.300003 y n Wide characters

関連項目

数値演算と浮動小数点のサポート
ストリーム入出力
ロケール
printf、 _printf_l、 wprintf、 _wprintf_l
scanf、 _scanf_l、 wscanf、 _wscanf_l
scanf_s、 _scanf_s_l、 wscanf_s、 _wscanf_s_l
vscanf, vwscanf