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

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

输入/输出库

I/O 操纵器

打印函数 (C++23)

C 风格 I/O

缓冲区

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

流

抽象

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

文件 I/O

basic_ifstream

basic_ofstream

basic_fstream

字符串 I/O

basic_istringstream

basic_ostringstream

basic_stringstream

数组 I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同步输出

basic_osyncstream (C++20)

类型

streamoff

streamsize

fpos

错误类别接口

iostream_category (C++11)

io_errc (C++11)

 

C 风格 I/O

类型和对象
FILE fpos_t	stdinstdoutstderr
函数
文件访问 fopen freopen fclose fflush fwide setbuf setvbuf 直接输入/输出 fread fwrite 非格式化输入/输出 fgetcgetc fgets fputcputc fputs getchar gets (直到 C++14) putchar puts ungetc fgetwcgetwc fgetws fputwcputwc fputws getwchar putwchar ungetwc 格式化输入 scanffscanfsscanf vscanfvfscanfvsscanf (C++11 起)(C++11 起)(C++11 起)     wscanffwscanfswscanf vwscanfvfwscanfvswscanf (C++11 起)(C++11 起)(C++11 起)	格式化输出 printffprintfsprintfsnprintf (C++11 起) vprintfvfprintfvsprintfvsnprintf (C++11 起)     wprintffwprintfswprintf vwprintfvfwprintfvswprintf 文件定位 ftell fgetpos fseek fsetpos rewind 错误处理 clearerr feof ferror perror 文件操作 remove rename tmpfile tmpnam

 

定义于头文件 <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 起可用→		是				是	是	是	是
%	匹配字面量 `%`。	不适用	不适用	不适用	不适用	不适用	不适用	不适用	不适用	不适用
c	匹配一个字符或一系列字符。 如果使用宽度说明符，则精确匹配 *width* 个字符（参数必须是指向具有足够空间的数组的指针）。 与 %s 和 %[ 不同，不会在数组末尾添加空字符。	不适用	不适用	char*	wchar_t*	不适用	不适用	不适用	不适用	不适用
s	匹配一系列非空白字符（一个字符串）。 如果使用宽度说明符，则匹配最多 *width* 个字符或直到第一个空白字符，以先出现的为准。 除了匹配的字符外，始终存储一个空字符（因此参数数组必须至少有 *width+1* 个字符的空间）。
[set ]	匹配来自字符 set 的非空字符序列。 如果集合的第一个字符是 `^`，则匹配集合中不包含的所有字符。 如果集合以 `]` 或 `^]` 开头，则 `]` 字符也包含在集合中。 在扫描集中非起始位置的字符 `-` 是否表示范围（如 `[0-9]`）是实现定义的。 如果使用宽度说明符，则只匹配最多 *width* 个字符。 除了匹配的字符外，始终存储一个空字符（因此参数数组必须至少有 *width+1* 个字符的空间）。
d	匹配一个十进制整数。 数字格式与 std::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*	std::intmax_t* 或 std::uintmax_t*	std::size_t*	std::ptrdiff_t*	不适用
i	匹配一个整数。 数字格式与 std::strtol 期望的相同，其中 base 参数的值为 ​0​（基数由解析的第一个字符确定）。
u	匹配一个无符号十进制整数。 数字格式与 std::strtoul 期望的相同，其中 base 参数的值为 10。
o	匹配一个无符号八进制整数。 数字格式与 std::strtoul 期望的相同，其中 base 参数的值为 8。
x X	匹配一个无符号十六进制整数。 数字格式与 std::strtoul 期望的相同，其中 base 参数的值为 16。
n	返回目前读取的字符数。 不消耗输入。不增加赋值计数。 如果说明符定义了赋值抑制运算符，则行为是未定义的。
a (C++11 起) A (C++11 起) e E f F (C++11 起) g G	匹配一个浮点数。 数字格式与 std::strtof 期望的相同。	不适用	不适用	float*	double*	不适用	不适用	不适用	不适用	long double*
p	匹配定义指针的实现定义的字符序列。 `printf` 函数族应使用 `%p` 格式说明符生成相同的序列。	不适用	不适用	void**	不适用	不适用	不适用	不适用	不适用	不适用
注意
对于除了 n 之外的每个转换说明符，从流中消耗的输入字符序列最长，且不超过任何指定的字段宽度，并且要么与转换说明符期望的完全相同，要么是其期望序列的前缀。如果存在，此消耗序列之后的第一个字符仍未读取。如果消耗的序列长度为零，或者如果消耗的序列无法按上述方式转换，则发生匹配失败，除非文件结束、编码错误或读取错误阻止了流输入，在这种情况下是输入失败。 除了 [、c 和 n 之外的所有转换说明符，在尝试解析输入之前，会消耗并丢弃所有前导空白字符（通过调用 std::isspace 确定）。这些消耗的字符不计入指定的最大字段宽度。 转换说明符 lc、ls 和 l[ 执行多字节到宽字符的转换，如同在转换第一个字符之前，通过调用 std::mbrtowc 并使用初始化为零的 std::mbstate_t 对象一样。 转换说明符 s 和 [ 除了匹配的字符外，总是存储空终止符。目标数组的大小必须至少比指定的字段宽度大一。在不指定目标数组大小的情况下使用 %s 或 %[，与使用 std::gets 一样不安全。 固定宽度整数类型（std::int8_t 等）的正确转换规范定义在头文件 <cinttypes> 中（尽管 SCNdMAX、SCNuMAX 等与 %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

参阅

scanffscanfsscanf	从 stdin、文件流或缓冲区读取格式化输入 (函数)
vprintfvfprintfvsprintfvsnprintf (C++11 起)	将格式化输出打印到 stdout、文件流或缓冲区 使用可变参数列表 (函数)
C 文档 适用于 vscanf, vfscanf, vsscanf