命名空间
变体
操作

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

来自 cppreference.cn
< cpp‎ | io‎ | c
 
 
 
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) 从空终止的字符字符串 buffer 读取数据。

内容

[编辑] 参数

stream - 要从中读取的输入文件流
buffer - 指向要从中读取的空终止字符字符串的指针
format - 指向空终止字符字符串的指针,指定如何读取输入
vlist - 包含接收参数的可变参数列表。


format 字符串由以下部分组成:

  • 非空白多字节字符,除了 %:格式字符串中的每个此类字符都恰好消耗输入流中的一个相同字符,如果流中的下一个字符不相等,则导致函数失败。
  • 空白字符:格式字符串中的任何单个空白字符都会消耗输入中所有可用的连续空白字符(如同在循环中调用 std::isspace 确定)。请注意,"\n"" ""\t\t" 或格式字符串中的其他空白之间没有区别。
  • 转换规范。每个转换规范都具有以下格式:
  • 引导 % 字符。
  • (可选) 赋值抑制字符 *。如果存在此选项,则函数不会将转换结果分配给任何接收参数。
  • (可选) 整数数字(大于零),用于指定最大字段宽度,即函数在执行当前转换规范指定的转换时允许消耗的最大字符数。请注意,如果未提供宽度,则 %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

匹配一个 十进制整数

  • 数字的格式与 std::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*
N/A
i

匹配一个 整数

  • 数字的格式与 std::strtol 期望的格式相同,其中 0 作为 base 参数的值(基数由解析的第一个字符确定)。
u

匹配一个无符号 十进制整数

  • 数字的格式与 std::strtoul 期望的格式相同,其中 10 作为 base 参数的值。
o

匹配一个无符号 八进制整数

  • 数字的格式与 std::strtoul 期望的格式相同,其中 8 作为 base 参数的值。
x
X

匹配一个无符号 十六进制整数

  • 数字的格式与 std::strtoul 期望的格式相同,其中 16 作为 base 参数的值。
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 之外的每个转换说明符,最长的输入字符序列(不超过任何指定的字段宽度,并且要么与转换说明符期望的完全相同,要么是它期望的序列的前缀)是从流中消耗的。此消耗序列之后的第一个字符(如果有)保持未读取状态。如果消耗的序列长度为零,或者如果消耗的序列无法按上述方式转换,则会发生匹配失败,除非文件结束、编码错误或读取错误阻止了从流中输入,在这种情况下,它是输入失败。

[cn 之外的所有转换说明符在尝试解析输入之前,都会消耗并丢弃所有前导空白字符(如同调用 std::isspace 确定)。这些消耗的字符不计入指定的最大字段宽度。

转换说明符 lclsl[ 执行多字节到宽字符的转换,如同在转换第一个字符之前,通过调用 std::mbrtowc 和初始化为零的 std::mbstate_t 对象。

转换说明符 s[ 始终存储空终止符以及匹配的字符。目标数组的大小必须至少比指定的字段宽度大一。不指定目标数组大小而使用 %s%[std::gets 一样不安全。

固定宽度整数类型(std::int8_t 等)的正确转换规范在头文件 <cinttypes> 中定义(尽管 SCNdMAXSCNuMAX 等与 %jd%ju 等同义)。

每个转换说明符的操作之后都有一个序列点; 这允许在同一个“接收器”变量中存储多个字段。

当解析以指数结尾且没有数字的不完整浮点值时,例如使用转换说明符 %f 解析 "100er" 时,序列 "100e"(可能是有效浮点数的最长前缀)被消耗,导致匹配错误(消耗的序列无法转换为浮点数),"r" 保持不变。某些现有实现不遵循此规则,而是回退到仅消耗 "100",留下 "er",例如 glibc bug 1765

如果转换规范无效,则行为未定义。

[编辑] 返回值

成功读取的参数数量,如果发生故障,则为 EOF

[编辑] 注意

所有这些函数都至少调用一次 va_arg,返回值后 arg 的值是不确定的。这些函数不调用 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、文件流或缓冲区读取格式化输入
(函数) [编辑]
将格式化输出打印到 stdout、文件流或缓冲区
使用可变参数列表
(函数) [编辑]
C 文档 关于 vscanfvfscanfvsscanf