命名空间
变体
操作

std::scanf、std::fscanf、std::sscanf

来自 cppreference.com
< cpp‎ | io‎ | c
 
C++
 
输入/输出库
 
C 风格 I/O
类型和对象
函数
文件访问
直接输入/输出
无格式输入/输出
格式化输入
scanffscanfsscanf
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
 
定义在头文件 <cstdio> 中
int scanf( const char* format, ... );
 (1)
int fscanf( std::FILE* stream, const char* format, ... );
 (2)
int sscanf( const char* buffer, const char* format, ... );
 (3)

从各种来源读取数据，根据 format 解释数据，并将结果存储到给定的位置。

1) 从 stdin 读取数据。
2) 从文件流 stream 读取数据。
3) 从以 null 结尾的字符字符串 buffer 读取数据。

内容

[编辑] 参数

stream - 要从中读取的输入文件流
buffer - 指向要从中读取的以 null 结尾的字符字符串的指针
format - 指向指定如何读取输入的以 null 结尾的字符字符串的指针
... - 接收参数

format 字符串包含

  • 非空白多字节字符，除了 %：格式字符串中的每个此类字符都会从输入流中消耗一个完全相同的字符，或者如果流上的下一个字符不等于，则导致函数失败。
  • 空白字符：格式字符串中的任何单个空白字符都会消耗输入流中所有可用的连续空白字符（如同通过循环调用 isspace 所确定的）。请注意，"\n"、" "、"\t\t" 或格式字符串中的其他空白字符之间没有区别。
  • 转换说明。每个转换说明具有以下格式
  • 介绍性的 % 字符。
  • (可选) 赋值抑制字符 *。如果存在此选项，则函数不会将转换结果分配给任何接收参数。
  • (可选) 整数（大于零），指定最大字段宽度，即函数在执行当前转换说明指定的转换时允许消耗的最大字符数。请注意，%s 和 %[ 如果没有提供宽度，可能会导致缓冲区溢出。
  • (可选)长度修饰符，指定接收参数的大小，即实际的目标类型。这会影响转换精度和溢出规则。默认目标类型因每个转换类型而异（请参见下表）。
  • 转换格式说明符。

以下格式说明符可用

转换
说明符		 解释 参数类型
长度修饰符 →
 hh

(C++11)

h (无) l ll

(C++11)

j

(C++11)

z

(C++11)

t

(C++11)

L
% 匹配文字 %。 N/A N/A N/A N/A N/A N/A N/A N/A N/A
c
匹配一个字符或一系列字符。

如果使用宽度说明符，则匹配正好宽度个字符（参数必须是指向具有足够空间的数组的指针）。与 %s 和 %[ 不同，不会在数组中附加 null 字符。

 N/A N/A
char*
wchar_t*
 N/A N/A N/A N/A N/A
s
匹配一系列非空白字符（一个字符串）。

如果使用宽度说明符，则匹配最多宽度个字符，或匹配到第一个空白字符，以先出现者为准。始终存储一个 null 字符，除了匹配的字符之外（因此参数数组必须至少有宽度+1 个字符的空间）

[set]
匹配从set中的字符组成的非空序列。

如果 set 的第一个字符是^，则匹配 set 中没有的所有字符。如果 set 以] 或 ^] 开头，则] 字符也包含在 set 中。是否允许扫描集中非初始位置的字符 - 表示一个范围（如 [0-9]） 是由实现定义的。如果使用宽度说明符，则仅匹配最多宽度个字符。始终存储一个 null 字符，除了匹配的字符之外（因此参数数组必须至少有宽度+1 个字符的空间）

d
匹配一个十进制整数。

数字的格式与 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*
size_t*
ptrdiff_t*
 N/A
i
匹配一个整数。

数字的格式与 strtol 使用 base 参数值为 ​0​ 时预期的一致（基数由解析的第一个字符决定）。

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

数字的格式与 strtoul 使用 base 参数值为 10 时预期的一致。

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

数字的格式与 strtoul 使用 base 参数值为 8 时预期的一致。

x, X
匹配一个无符号十六进制整数。

数字的格式与 strtoul 使用 base 参数值为 16 时预期的一致。

n
返回到目前为止读取的字符数。

不消耗任何输入。不增加赋值计数。如果该说明符定义了抑制赋值操作符，则其行为未定义。

a, A(C++11)
e, E
f, F
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[ 执行多字节到宽字符的转换，如同调用 mbrtowc 一样，并使用一个在转换第一个字符之前初始化为零的 mbstate_t 对象。

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

标头 <cinttypes> 中定义了用于定长整数类型（int8_t 等）的正确转换说明符（尽管 SCNdMAX、SCNuMAX 等与 %jd、%ju 等是同义词）。

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

当解析以指数结尾但没有数字的未完成浮点数时，例如使用转换说明符 %f 解析 "100er"，序列 "100e"（可能是有效浮点数的最长前缀）将被消耗，导致匹配错误（消耗序列无法转换为浮点数），并留下 "r"。一些现有的实现不遵循此规则，而是回滚以仅消耗 "100"，留下 "er"，例如 glibc 错误 1765。

[edit] 返回值

成功分配的接收参数数量（如果在第一个接收参数分配之前发生了匹配失败，则可能为零），或者如果在第一个接收参数分配之前发生输入失败，则为 EOF。

[edit] 复杂度

不保证。值得注意的是，std::sscanf 的一些实现是 O(N)，其中 N = std::strlen(buffer) [1]。对于性能优化的字符串解析，请参见 std::from_chars。

[edit] 注释

因为大多数转换说明符首先会消耗所有连续的空白符，所以像这样的代码：

std::scanf("%d", &a);
std::scanf("%d", &b);

将读取在不同行上输入的两个整数（第二个 %d 将消耗第一个留下的换行符）或在同一行上输入的两个整数，它们之间用空格或制表符分隔（第二个 %d 将消耗空格或制表符）。

不消耗前导空白符的转换说明符，例如 %c，可以通过在格式字符串中使用空白符来实现此目的。
std::scanf("%d", &a);
std::scanf(" %c", &c); // ignore the endline after %d, then read a char

请注意，std::sscanf 的一些实现涉及调用 std::strlen，这使其运行时间与整个字符串的长度呈线性关系。这意味着，如果在循环中调用 std::sscanf 以反复解析字符串开头的值，则您的代码可能会以二次时间运行 (示例)。

[edit] 示例

运行此代码
#include <clocale>
#include <cstdio>
#include <iostream>
 
int main()
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    std::setlocale(LC_ALL, "en_US.utf8");
 
    char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水";
    // parse as follows:
    // %d: an integer 
    // %f: a floating-point value
    // %9s: a string of at most 9 non-whitespace characters
    // %2d: two-digit integer (digits 5 and 6)
    // %f: a floating-point value (digits 7, 8, 9)
    // %*d an integer which isn't stored anywhere
    // ' ': all consecutive whitespace
    // %3[0-9]: a string of at most 3 digits (digits 5 and 6)
    // %2lc: two wide characters, using multibyte to wide conversion
    const int ret = std::sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                                &i, &x, str1, &j, &y, str2, warr);
 
    std::cout << "Converted " << ret << " fields:\n"
                 "i = " << i << "\n"
                 "x = " << x << "\n"
                 "str1 = " << str1 << "\n"
                 "j = " << j << "\n"
                 "y = " << y << "\n"
                 "str2 = " << str2 << std::hex << "\n"
                 "warr[0] = U+" << (int)warr[0] << "\n"
                 "warr[1] = U+" << (int)warr[1] << '\n';
}

输出

Converted 7 fields:
i = 25
x = 5.432
str1 = Thompson
j = 56
y = 789
str2 = 56
warr[0] = U+df
warr[1] = U+6c34

[edit] 另请参见

(C++11)(C++11)(C++11)
 从 stdin、文件流或缓冲区读取格式化输入
使用可变参数列表
(函数) [edit]
 从文件流获取一个字符字符串
(函数) [edit]
(C++11)
 将格式化输出打印到 stdout、文件流或缓冲区
(函数) [edit]
(C++17)
 将字符序列转换为整数或浮点数
(函数) [edit]
C 文档 针对 scanf, fscanf, sscanf
从 "https://cppreference.cn/mwiki/index.php?title=cpp/io/c/fscanf&oldid=158702" 中检索