命名空间
变体
操作

scanf, fscanf, sscanf, scanf_s, fscanf_s, sscanf_s

来自 cppreference.cn
< c‎ | io
 
C
 
文件输入/输出
类型和对象
        
函数
文件访问
(C11)
(C11)  
(C95)
未格式化输入/输出
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)
(C95)
(C95)

格式化输入
scanffscanfsscanfscanf_sfscanf_ssscanf_s
(C11)(C11)(C11)
(C95)(C95)(C95)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)  
 
定义于头文件 <stdio.h>
(1)
int scanf( const char          *format, ... );
 (C99 前)
int scanf( const char *restrict format, ... );
 (C99 起)
(2)
int fscanf( FILE          *stream, const char          *format, ... );
 (C99 前)
int fscanf( FILE *restrict stream, const char *restrict format, ... );
 (C99 起)
(3)
int sscanf( const char          *buffer, const char          *format, ... );
 (C99 前)
int sscanf( const char *restrict buffer, const char *restrict format, ... );
 (C99 起)
int scanf_s(const char *restrict format, ...);
 (4) (C11 起)
int fscanf_s(FILE *restrict stream, const char *restrict format, ...);
 (5) (C11 起)
int sscanf_s(const char *restrict buffer, const char *restrict format, ...);
 (6) (C11 起)

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

1) 从 stdin 读取数据
2) 从文件流 stream 读取数据
3) 从空字符结尾的字符串 buffer 读取数据。到达字符串末尾等同于 fscanf 遇到文件结束条件。
4-6) 与 (1-3) 相同，除了 %c、 %s 和 %[ 转换说明符各自需要两个参数（通常的指针和一个 rsize_t 类型的值，指示接收数组的大小，当使用 %c 读取到单个 char 时，该值可能为 1），并且除了以下错误在运行时检测到并调用当前安装的约束处理函数
  • 任何指针类型的参数为空指针
  • format、stream 或 buffer 为空指针
  • 由 %c、 %s 或 %[ 加上终止空字符写入的字符数，将超过为每个转换说明符提供的第二个 (rsize_t) 参数
  • 可选地，任何其他可检测错误，例如未知的转换说明符
与所有边界检查函数一样，scanf_s、 fscanf_s 和 sscanf_s 仅在实现定义了 __STDC_LIB_EXT1__ 并且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时，才能保证可用。

目录

[编辑] 参数

stream - 从中读取数据的输入文件流
buffer - 从中读取数据的空字符结尾的字符串指针
format - 指向空字符结尾的字符串的指针，该字符串指定如何读取输入
... - 接收参数。


format 字符串由以下部分组成

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

以下是可用的格式说明符

转换
说明符		 解释 预期
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅 C99 起可用→ 是 是 是 是 是
%
匹配字面量 %。
 N/A N/A N/A N/A N/A N/A N/A N/A N/A
c

匹配一个字符或字符序列。

  • 如果使用宽度说明符，则精确匹配宽度个字符（参数必须是指向具有足够空间的数组的指针）。
  • 与 %s 和 %[, 不同，不会将空字符附加到数组。
 N/A N/A
char*
wchar_t*
 N/A N/A N/A N/A N/A
s

匹配非空白字符序列（字符串）。

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

匹配来自字符 set 的非空字符序列。

  • 如果集合的第一个字符是 ^，则匹配所有不在集合中的字符。
  • 如果集合以 ] 或 ^] 开头，则 ] 字符也包含在集合中。
  • 实现定义了扫描集非初始位置的字符 - 是否可以指示范围，如 [0-9] 中所示。
  • 如果使用宽度说明符，则仅匹配最多 width 个字符。
  • 始终存储一个空字符，以及匹配的字符（因此参数数组必须至少有 width+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*
N/A
i

匹配整数。

  • 数字的格式与 strtol 期望的格式相同，base 参数的值为 ​0​（base 由解析的第一个字符确定）。
u

匹配无符号十进制整数。

  • 数字的格式与 strtoul 期望的格式相同，base 参数的值为 10。
o

匹配无符号八进制整数。

  • 数字的格式与 strtoul 期望的格式相同，base 参数的值为 8。
x
X

匹配无符号十六进制整数。

  • 数字的格式与 strtoul 期望的格式相同，base 参数的值为 16。
n

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

  • 不消耗任何输入。 不会增加赋值计数。
  • 如果说明符定义了赋值抑制运算符，则行为未定义。
a (C99)
A (C99)
e
E
f
F (C99)
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[ 执行多字节到宽字符的转换，如同在转换第一个字符之前使用初始化为零的 mbstate_t 对象调用 mbrtowc。

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

固定宽度整数类型（int8_t 等）的正确转换说明符在头文件 <inttypes.h> 中定义（尽管 SCNdMAX、 SCNuMAX 等与 %jd、 %ju 等同义）。

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

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

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

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

[编辑] 返回值

1-3) 成功赋值的接收参数的数量（如果在第一个接收参数赋值之前发生匹配失败，则可能为零），或者如果在第一个接收参数赋值之前发生输入失败，则为 EOF。
4-6) 与 (1-3) 相同，除了如果存在运行时约束冲突，也会返回 EOF。

[编辑] 复杂度

不保证。值得注意的是，sscanf 的某些实现是 O(N)，其中 N = strlen(buffer) [1]。

[编辑] 注释

由于大多数转换说明符首先消耗所有连续的空白，因此像这样的代码

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

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

不消耗前导空白的转换说明符（例如 %c）可以通过在 format 字符串中使用空白字符来实现。
scanf("%d", &a);
scanf(" %c", &c); // consume all consecutive whitespace after %d, then read a char

[编辑] 示例

运行此代码
#define __STDC_WANT_LIB_EXT1__ 1
#include <stdio.h>
#include <stddef.h>
#include <locale.h>
 
int main(void)
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    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 decimal digits (digits 5 and 6)
       %2lc: two wide characters, using multibyte to wide conversion  */
    int ret = sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                     &i, &x, str1, &j, &y, str2, warr);
 
    printf("Converted %d fields:\n"
           "i = %d\n"
           "x = %f\n"
           "str1 = %s\n"
           "j = %d\n"
           "y = %f\n"
           "str2 = %s\n"
           "warr[0] = U+%x\n"
           "warr[1] = U+%x\n",
           ret, i, x, str1, j, y, str2, warr[0], warr[1]);
 
#ifdef __STDC_LIB_EXT1__
    int n = sscanf_s(input, "%d%f%s", &i, &x, str1, (rsize_t)sizeof str1);
    // writes 25 to i, 5.432 to x, the 9 bytes "Thompson\0" to str1, and 3 to n.
#endif
}

可能的输出

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

[编辑] 参考

  • C17 标准 (ISO/IEC 9899:2018)
  • 7.21.6.2 fscanf 函数 (p: 231-236)
  • 7.21.6.4 scanf 函数 (p: 236-237)
  • 7.21.6.7 sscanf 函数 (p: 238-239)
  • K.3.5.3.2 fscanf_s 函数 (p: 430-431)
  • K.3.5.3.4 scanf_s 函数 (p: 432)
  • K.3.5.3.7 sscanf_s 函数 (p: 433)
  • C11 标准 (ISO/IEC 9899:2011)
  • 7.21.6.2 fscanf 函数 (p: 317-324)
  • 7.21.6.4 scanf 函数 (p: 325)
  • 7.21.6.7 sscanf 函数 (p: 326)
  • K.3.5.3.2 fscanf_s 函数 (p: 592-593)
  • K.3.5.3.4 scanf_s 函数 (p: 594)
  • K.3.5.3.7 sscanf_s 函数 (p: 596)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.19.6.2 fscanf 函数 (p: 282-289)
  • 7.19.6.4 scanf 函数 (p: 290)
  • 7.19.6.7 sscanf 函数 (p: 291)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 4.9.6.2 fscanf 函数
  • 4.9.6.4 scanf 函数
  • 4.9.6.6 sscanf 函数

[编辑] 参见

(C99)(C99)(C99)(C11)(C11)(C11)
 从 stdin、文件流或缓冲区读取格式化输入
使用可变参数列表
(函数) [编辑]
 从文件流获取字符字符串
(函数) [编辑]
(C99)(C11)(C11)(C11)(C11)
 将格式化输出打印到 stdout、文件流或缓冲区
(函数) [编辑]
C++ 文档 for scanf, fscanf, sscanf
Retrieved from "https://cppreference.cn/mwiki/index.php?title=c/io/fscanf&oldid=140798"