Namespaces
Variants

vscanf, vfscanf, vsscanf, vscanf_s, vfscanf_s, vsscanf_s

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Functions
File access
Unformatted input/output
Formatted input
vscanf vfscanf vsscanf vscanf_s vfscanf_s vsscanf_s
(C99) (C99) (C99) (C11) (C11) (C11)
(C99) (C99) (C99) (C11) (C11) (C11)
ヘッダーで定義 <stdio.h>
int vscanf ( const char * restrict format, va_list vlist ) ;
(1) (C99以降)
int vfscanf ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(2) (C99以降)
int vsscanf ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(3) (C99以降)
int vscanf_s ( const char * restrict format, va_list vlist ) ;
(4) (C11以降)
int vfscanf_s ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(5) (C11以降)
int vsscanf_s ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(6) (C11以降)

多様なソースからデータを読み取り、 format に従って解釈し、結果を vlist で定義された場所に格納します。

1) stdin からデータを読み取る
2) ファイルストリーム stream からデータを読み取る
3) ヌル終端文字列からデータを読み取ります。 buffer 文字列の終端に到達することは、 fscanf にとってファイル終端条件に到達することと同等です。
4-6) (1-3) と同様であるが、 % c 、 % s 、および % [ 変換指定子はそれぞれ2つの引数を期待する点（通常のポインタと、受信配列のサイズを示す型 rsize_t の値。%cを使用して単一のcharに読み込む場合は1となる）と、以下のエラーが実行時に検出され、現在インストールされている 制約ハンドラ 関数を呼び出す点が異なる：
  • ポインタ型の引数のいずれかがヌルポインタである場合
  • format 、 stream 、または buffer がヌルポインタである場合
  • %c、%s、または%[によって書き込まれる文字数に終端ナル文字を加えたものが、各変換指定子に提供された第2（rsize_t）引数を超える場合
  • オプションで、未知の変換指定子などの他の検出可能なエラー
すべての境界チェック付き関数と同様に、 vscanf_s 、 vfscanf_s 、および vsscanf_s は、実装によって __STDC_LIB_EXT1__ が定義され、かつユーザーが <stdio.h> をインクルードする前に __STDC_WANT_LIB_EXT1__ を整数定数 1 に定義した場合にのみ利用可能であることが保証される。

目次

翻訳のポイント： - 「Contents」→「目次」に翻訳 - HTMLタグ、属性、リンク先は一切変更せず保持 - C++関連の用語（Parameters、Return value、Exampleなど）は原文のまま保持 - 数値、書式、構造は完全に維持

パラメータ

stream - 読み取り元の入力ファイルストリーム
buffer - 読み取り元のヌル終端文字列へのポインタ
format - 入力の読み取り方法を指定するヌル終端文字列へのポインタ
vlist - 受信引数を含む可変引数リスト


format 文字列は以下で構成されます

  • 空白文字以外のマルチバイト文字（ % を除く）: 書式文字列内の各文字は入力ストリームから正確に同一の文字1文字を消費する。ストリーム上の次の文字が等しくない場合、関数は失敗する。
  • 空白文字: 書式文字列内の単一の空白文字は、入力から利用可能な連続する全ての空白文字を消費する（ループ内で isspace を呼び出して判定される）。 " \n " 、 " " 、 " \t \t " など、書式文字列内の空白文字に違いはないことに注意。
  • 変換指定子。各変換指定子は以下の形式を持つ:
  • 導入部 % 文字。
  • (オプション) 代入抑制文字 * 。このオプションが存在する場合、関数は変換結果を受取り引数に代入しません。
  • (オプション) ゼロより大きい整数値で、 最大フィールド幅 を指定します。これは現在の変換指定子によって指定された変換を行う際に関数が消費できる最大文字数を示します。 % s および % [ は、幅が指定されていない場合バッファオーバーフローを引き起こす可能性があることに注意してください。
  • (オプション) 長さ修飾子 は、受信引数のサイズ、つまり実際の変換先の型を指定します。これは変換精度とオーバーフロー規則に影響します。デフォルトの変換先型は変換タイプごとに異なります（下記の表を参照）。
  • 変換フォーマット指定子。

以下のフォーマット指定子が利用可能です:

変換指定子
説明 期待される
引数の型
長さ修飾子→ hh h なし l ll j z t L
C99以降でのみ利用可能→ 可 可 可 可 可
%
リテラルの % に一致します。
N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

1文字または文字のシーケンスにマッチします。

  • 幅指定子が使用されている場合、正確に width 文字にマッチします（引数は十分な領域を持つ配列へのポインタでなければなりません）。
  • %sや%[とは異なり、配列にnull文字を追加しません。
N/A N/A
char *
wchar_t *
N/A N/A N/A N/A N/A
s

空白以外の文字の連続（ 文字列 ）にマッチします。

  • 幅指定子が使用されている場合、 width まで、または最初の空白文字のいずれか先に現れる方にマッチします。
  • 常にマッチした文字に加えてヌル文字を格納します（そのため、引数の配列には少なくとも width+1 文字分の領域が必要です）。
[ set  ]

set 内の文字からなる空でない文字シーケンスにマッチします。

  • セットの最初の文字が ^ の場合、セットに含まれないすべての文字がマッチします。
  • セットが ] または ^] で始まる場合、 ] 文字もセットに含まれます。
  • スキャンセット内の先頭以外の位置にある - 文字が [0-9] のように範囲を示すかどうかは実装定義です。
  • 幅指定子が使用されている場合、最大 width 文字までマッチします。
  • 常にマッチした文字に加えてnull文字を格納します（したがって、引数配列には少なくとも width+1 文字分の領域が必要です）。
d

10進整数 にマッチします。

  • 数値の形式は、 strtol 関数が 10 を base 引数として期待する形式と同じです。
signed char * または unsigned char *
signed short * または unsigned short *
signed int * または unsigned int *
signed long * または unsigned long *
signed long long * または unsigned long long *
該当なし
i

整数 にマッチします。

  • 数値のフォーマットは、 strtol が ​ 0 ​ を base 引数として期待するものと同じです（基数は解析された最初の文字によって決定されます）。
u

符号なし 10進整数 にマッチします。

  • 数値の形式は、 strtoul 関数が 10 を base 引数として期待する形式と同じです。
o

符号なし 8進整数 にマッチします。

  • 数値のフォーマットは、 strtoul 関数で 8 を base 引数として指定した場合と同じ形式です。
x
X

符号なし 16進数整数 にマッチします。

  • 数値のフォーマットは、 strtoul 関数が 16 を base 引数として期待するものと同じです。
n

これまでに読み取られた文字数 を返します。

  • 入力は消費されません。代入カウントは増加しません。
  • 指定子に代入抑制演算子が定義されている場合、動作は未定義です。
a (C99)
A (C99)
e
E
f
F (C99)
g
G

浮動小数点数 にマッチします。

  • 数値のフォーマットは strtof が期待するものと同じです。
N/A N/A
float *
double *
N/A N/A N/A N/A
long double *
p

実装定義の文字シーケンスにマッチし、 ポインタ を定義します。

  • printf 関数群は同じシーケンスを %p フォーマット指定子を使用して生成する必要があります。
N/A N/A
void **
N/A N/A N/A N/A N/A N/A
注記

n 以外のすべての変換指定子について、指定されたフィールド幅を超えず、かつ変換指定子が期待する文字列と完全に一致するか、期待する文字列の接頭辞であるような入力文字の最長シーケンスが、ストリームから消費されます。この消費されたシーケンスの後の最初の文字（存在する場合）は読み取られずに残されます。消費されたシーケンスの長さがゼロである場合、または消費されたシーケンスが上記のように変換できない場合、マッチング失敗が発生します。ただし、ストリームからの入力がファイル終端、エンコーディングエラー、または読み取りエラーによって妨げられた場合は、入力失敗となります。

[ 、 c 、 n 以外のすべての変換指定子は、入力を解析する前に、すべての先行する空白文字（ isspace を呼び出して決定される）を消費して破棄します。これらの消費された文字は、指定された最大フィールド幅にカウントされません。

変換指定子 lc 、 ls 、 l [ は、最初の文字が変換される前にゼロに初期化された mbstate_t オブジェクトを使用して mbrtowc を呼び出すかのように、マルチバイトからワイド文字への変換を実行します。

変換指定子 s と [ は、常に一致した文字に加えてナルターミネータを格納します。変換先配列のサイズは、指定されたフィールド幅より少なくとも1大きくなければなりません。変換先配列のサイズを指定せずに % s または % [ を使用することは、 gets と同じくらい安全ではありません。

固定幅整数型 （ int8_t など）に対する正しい変換指定は、ヘッダ <inttypes.h> で定義されています（ただし SCNdMAX 、 SCNuMAX などは % jd 、 % ju などと同義です）。

各変換指定子の動作の後に シーケンスポイント が存在します。これにより、複数のフィールドを同じ「シンク」変数に格納することが可能になります。

指数部で終わる不完全な浮動小数点値（例えば "100er" を変換指定子 % f で解析する場合）を解析するとき、 "100e" （有効な浮動小数点数の可能性のある最長の接頭辞）が消費され、マッチングエラー（消費されたシーケンスを浮動小数点数に変換できない）が発生し、 "r" が残ります。既存の実装の中にはこの規則に従わず、 "100" のみを消費するようにロールバックし、 "er" を残すものもあります（例： glibc bug 1765 ）。

変換指定が無効な場合、動作は未定義です。

戻り値

1-3) 正常に代入された受信引数の数、または EOF 最初の受信引数が代入される前に読み込み失敗が発生した場合。
4-6) 以下は (1-3) と同じですが、 EOF は実行時制約違反が発生した場合にも返されます。

注記

これらの関数はすべて少なくとも1回 va_arg を呼び出し、戻り値の後では arg の値は不定となります。これらの関数は va_end を呼び出さないため、呼び出し元が実行する必要があります。

例

このコードを実行 
#include <stdio.h>
#include <stdbool.h>
#include <stdarg.h>
bool checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
    int rc = vsscanf(buf, fmt, ap);
    va_end(ap);
    return rc == count;
}
int main(void)
{
    int n, m;
    printf("Parsing '1 2'...");
    if(checked_sscanf(2, "1 2", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
    printf("Parsing '1 a'...");
    if(checked_sscanf(2, "1 a", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
}

出力: 

Parsing '1 2'...success
Parsing '1 a'...failure

参考文献

  • C11規格 (ISO/IEC 9899:2011):
  • 7.21.6.9 vfscanf関数 (p: 327)
  • 7.21.6.11 vscanf関数 (p: 328)
  • 7.21.6.14 vsscanf関数 (p: 330)
  • K.3.5.3.9 vfscanf_s関数 (p: 597-598)
  • K.3.5.3.11 vscanf_s関数 (p: 599)
  • K.3.5.3.14 vsscanf_s関数 (p: 602)
  • C99規格 (ISO/IEC 9899:1999):
  • 7.19.6.9 vfscanf関数 (p: 293)
  • 7.19.6.11 vscanf関数 (p: 294)
  • 7.19.6.14 vsscanf関数 (p: 295)

関連項目

(C11) (C11) (C11)
書式付き入力を stdin 、ファイルストリーム、またはバッファから読み込む
(関数)
(C99) (C11) (C11) (C11) (C11)
可変引数リストを使用して書式付き出力を stdout 、ファイルストリーム、またはバッファに出力する
(関数)
C++ドキュメント for vscanf , vfscanf , vsscanf