命名空间
变体
操作

std::scanf, std::fscanf, std::sscanf

来自 cppreference.cn
< 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 - 指向要从中读取的以空字符结尾的字符串的指针
format - 指向以空字符结尾的字符串的指针，指定如何读取输入
... - 接收参数

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*
不适用
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

匹配一个浮点数。

 不适用 不适用
float*
double*
 不适用 不适用 不适用 不适用
long double*
p

匹配定义指针的实现定义的字符序列。

  • `printf` 函数族应使用 `%p` 格式说明符生成相同的序列。
 不适用 不适用
void**
 不适用 不适用 不适用 不适用 不适用 不适用
注意

对于除了 n 之外的所有转换说明符，将消耗不超过指定字段宽度且与转换说明符预期完全相同或为其前缀的最长输入字符序列。此消耗序列之后的第一个字符（如果有）保持未读。如果消耗序列的长度为零，或者消耗序列无法按照上述指定进行转换，则会发生匹配失败，除非文件结束、编码错误或读取错误阻止了流输入，在这种情况下，它是一个输入失败。

除了 [、c 和 n 之外的所有转换说明符，在尝试解析输入之前，都会消耗并丢弃所有前导空白字符（通过调用 std::isspace 确定）。这些消耗的字符不计入指定的最大字段宽度。

转换说明符 lc、ls 和 l[ 执行多字节到宽字符的转换，就像在转换第一个字符之前，使用初始化为零的 std::mbstate_t 对象调用 std::mbrtowc 一样。

转换说明符 s 和 [ 除了匹配的字符外，总是存储空终止符。目标数组的大小必须至少比指定字段宽度大一。使用 %s 或 %[ 而不指定目标数组大小，与 std::gets 一样不安全。

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

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

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

如果转换说明符无效，则行为未定义。

[编辑] 返回值

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

[编辑] 复杂度

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

[编辑] 注意

因为大多数转换说明符首先消耗所有连续的空白，所以如下代码

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 在循环中被调用以重复从字符串开头解析值，您的代码可能会以二次时间运行（示例）。

[编辑] 示例

运行此代码
#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

[编辑] 另请参阅

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