名前空間
変種
操作

std::vscanf, std::vfscanf, std::vsscanf

From cppreference.com
< cpp‎ | io‎ | c
 
C++
コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ
 
入出力ライブラリ
 
C形式I/O
型とオブジェクト
関数
ファイルアクセス
直接入出力
非書式化入出力
書式付き入力
vscanfvfscanfvsscanf
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
書式付き出力
ファイルポジショニング
エラーハンドリング
ファイル操作
 
ヘッダ<cstdio>で定義
int vscanf( const char* format, std::va_list vlist );
 (1) (C++11以降)
int vfscanf( std::FILE* stream, const char* format, std::va_list vlist );
 (2) (C++11以降)
int vsscanf( const char* buffer, const char* format, std::va_list vlist );
 (3) (C++11以降)

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

1) stdin からデータを読み込みます。
2) ファイルストリーム stream からデータを読み込みます。
3) null終端の文字文字列 buffer からデータを読み込みます。

目次

[編集] パラメータ

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


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

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

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

変換
指定子		 説明 期待される
引数型
長さ修飾子→ hh h なし l ll j z t L
C++11からのみ利用可能→ はい はい はい はい はい
%
リテラル % にマッチします。
 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進整数 にマッチします。

  • 数値のフォーマットは、base 引数に 10 の値を指定して std::strtol が期待するフォーマットと同じです。
signed char* または unsigned char*
signed short* または unsigned short*
signed int* または unsigned int*
signed long* または unsigned long*
signed long long* または unsigned long long*
N/A
i

整数 にマッチします。

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

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

  • 数値のフォーマットは、base 引数に 10 の値を指定して std::strtoul が期待するフォーマットと同じです。
o

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

  • 数値のフォーマットは、base 引数に 8 の値を指定して std::strtoul が期待するフォーマットと同じです。
x
X

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

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

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

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

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

  • 数値のフォーマットは、std::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 を除くすべての変換指定子は、入力の解析を試みる前に、すべての先頭の空白文字（std::isspace を呼び出す場合と同様に決定されます）を消費して破棄します。これらの消費された文字は、指定された最大フィールド幅にはカウントされません。

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

変換指定子 s および [ は、一致した文字に加えて常にnull終端文字を格納します。宛先配列のサイズは、指定されたフィールド幅より少なくとも1つ大きい必要があります。 %s または %[ を、宛先配列のサイズを指定せずに使用することは、std::gets と同様に危険です。

固定幅整数型（std::int8_t など）の正しい変換指定子は、ヘッダー <cinttypes> で定義されています（ただし、SCNdMAX、SCNuMAX などは %jd、%ju などと同義です）。

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

指数部分に数字がない不完全な浮動小数点値（例: "100er" を変換指定子 %f で解析する場合）を解析する際、シーケンス "100e"（おそらく有効な浮動小数点数の最長のプレフィックス）が消費され、マッチングエラー（消費されたシーケンスは浮動小数点数に変換できません）が発生し、"r" が残ります。一部の実装はこの規則に従っておらず、"100" のみを消費するようにロールバックし、"er" を残します。例: glibc bug 1765。

変換指定子が不正な場合、動作は未定義です。

[編集] 戻り値

正常に読み込まれた引数の数、または失敗した場合は EOF。

[編集] 注意

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

[編集] 例

このコードを実行
#include <cstdarg>
#include <cstdio>
#include <iostream>
#include <stdexcept>
 
void checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    std::va_list ap;
    va_start(ap, fmt);
    if (std::vsscanf(buf, fmt, ap) != count)
        throw std::runtime_error("parsing error");
    va_end(ap);
}
 
int main()
{
    try
    {
        int n, m;
        std::cout << "Parsing '1 2'... ";
        checked_sscanf(2, "1 2", "%d %d", &n, &m);
        std::cout << "success\n";
        std::cout << "Parsing '1 a'... ";
        checked_sscanf(2, "1 a", "%d %d", &n, &m);
        std::cout << "success\n";
    }
    catch (const std::exception& e)
    {
        std::cout << e.what() << '\n';
    }
}

出力

Parsing '1 2'... success
Parsing '1 a'... parsing error

[編集] 関連項目

 stdin、ファイルストリーム、またはバッファから書式付き入力を読み取ります。
(関数) [編集]
(C++11)
 stdout、ファイルストリーム、またはバッファにフォーマットされた出力を書き込む
可変長引数リストを使用する
(関数) [編集]
Cドキュメント (vscanf, vfscanf, vsscanf)
"https://ja.cppreference.dev/mwiki/index.php?title=cpp/io/c/vfscanf&oldid=157667" から取得
English 日本語 中文(简体) 中文(繁體)