名前空間
変種
操作

vscanf、vfscanf、vsscanf、vscanf_s、vfscanf_s、vsscanf_s

From cppreference.com
< c‎ | io
 
C
 
ファイル入出力
型とオブジェクト
        
関数
ファイルアクセス
(C11)
(C11)  
(C95)
非書式化入出力
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)

書式付き入力
vscanfvfscanfvsscanfvscanf_svfscanf_svsscanf_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 に定義した場合にのみ利用できることが保証されています。

目次

[編集] パラメータ

stream - 読み込む入力ファイルストリーム
バッファ - 読み込むヌル終端された文字列へのポインタ
format - 入力をどのように読み込むかを指定するヌル終端された文字列へのポインタ
vlist - 受信引数を含む可変引数リスト。


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

  • 非空白マルチバイト文字 (% を除く)：書式文字列内のこのような各文字は、入力ストリームからまったく同じ文字を1つ消費します。ストリームの次の文字が同じでない場合、関数は失敗します。
  • 空白文字：書式文字列内の任意の単一の空白文字は、入力から利用可能な連続するすべての空白文字を消費します（isspace をループで呼び出した場合と同様に判断されます）。書式文字列内の "\n"、" "、"\t\t"、またはその他の空白文字に違いはありません。
  • 変換指定。各変換指定は次の形式です。
  • 導入の % 文字。
  • (オプション) 代入抑制文字 *。このオプションが存在する場合、関数は変換の結果をいかなる受信引数にも代入しません。
  • (オプション) 最大フィールド幅 を指定する整数（0より大きい）。つまり、現在の変換指定によって指定された変換を実行する際に、関数が消費できる最大文字数です。%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

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

  • 幅指定子が使用されている場合、正確に width 個の文字にマッチします（引数は十分なスペースを持つ配列へのポインタでなければなりません）。
  • %s および %[ とは異なり、ヌル文字を配列に追加しません。
 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 までのみマッチします。
  • マッチした文字に加えて常にヌル文字を格納します（したがって、引数配列は少なくとも width+1 文字のスペースが必要です）。
d

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

  • 数値の書式は、strtol が base 引数に値 10 を期待するのと同じです。
signed char* または unsigned char*
signed short* または unsigned short*
signed int* または unsigned int*
signed long* または unsigned long*
signed long long* または unsigned long long*
intmax_t* または uintmax_t*
N/A
i

整数 にマッチします。

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

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

  • 数値の書式は、strtoul が base 引数に値 10 を期待するのと同じです。
o

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

  • 数値の書式は、strtoul が base 引数に値 8 を期待するのと同じです。
x
X

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

  • 数値の書式は、strtoul が base 引数に値 16 を期待するのと同じです。
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 などと同義です）。

各変換指定子の動作の後に シーケンスポイント があります。これにより、複数のフィールドを同じ「シンク」変数に格納できます。

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

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

[編集] 戻り値

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

[編集] 注釈

これらすべての関数は va_arg を少なくとも1回呼び出します。関数の戻り後、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、ファイルストリーム、またはバッファに書式化された出力を書き出す
可変長引数リストを使用する
(関数) [編集]
vscanf, vfscanf, vsscanf の C++ ドキュメント
「https://ja.cppreference.dev/mwiki/index.php?title=c/io/vfscanf&oldid=125689」より取得
English 日本語 中文(简体) 中文(繁體)