Namespaces
Variants

vscanf, vfscanf, vsscanf, vscanf_s, vfscanf_s, vsscanf_s

From cppreference.net
< c ‎ | io
C
File input/output
Types and objects
Functions
File access
Unformatted input/output
Formatted input
vscanf vfscanf vsscanf vscanf_s vfscanf_s vsscanf_s
(C99) (C99) (C99) (C11) (C11) (C11)
(C99) (C99) (C99) (C11) (C11) (C11)
定义于头文件 <stdio.h>
int vscanf ( const char * restrict format, va_list vlist ) ;
(1) (C99起)
int vfscanf ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(2) (C99起)
int vsscanf ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(3) (C99起)
int vscanf_s ( const char * restrict format, va_list vlist ) ;
(4) (C11起)
int vfscanf_s ( FILE * restrict stream, const char * restrict format,
va_list vlist ) ;
(5) (C11起)
int vsscanf_s ( const char * restrict buffer, const char * restrict format,
va_list vlist ) ;
(6) (C11起)

从多种数据源读取数据，根据 format 进行解析，并将结果存储到 vlist 定义的存储位置。

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) 参数
  • 可选地，任何其他可检测到的错误，例如未知的转换说明符
与所有边界检查函数一样， vscanf_s 、 vfscanf_s 和 vsscanf_s 仅在实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时才保证可用。

目录

参数

stream - 用于读取的输入文件流
buffer - 指向以空字符结尾的字符串的指针，用于读取数据
format - 指向以空字符结尾的字符串的指针，指定输入读取格式
vlist - 包含接收参数的变长参数列表


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

  • 非空白多字节字符（除 % 外）：格式字符串中的每个此类字符会从输入流中消耗一个完全相同的字符，如果流中的下一个字符不相等则导致函数执行失败。
  • 空白字符：格式字符串中的任意单个空白字符会消耗输入中所有可用的连续空白字符（通过循环调用 isspace 确定）。注意格式字符串中的 " \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

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

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

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

  • 若使用宽度限定符，则最多匹配 width 个字符或遇到首个空白字符（以先出现者为准）。
  • 始终在匹配字符外额外存储一个空字符（因此参数数组必须至少有 width+1 字符的存储空间）。
[ set  ]

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

  • 若字符集的首字符为 ^ ，则匹配所有不在该集合中的字符。
  • 若字符集以 ] 或 ^] 开头，则 ] 字符也会被包含在集合中。
  • 在非起始位置出现的 - 字符是否表示范围（如 [0-9] ）由实现定义。
  • 若使用了宽度限定符，则最多匹配 width 个字符。
  • 始终在匹配的字符之外额外存储一个空字符（因此参数数组必须至少有 width+1 个字符的空间）。
d

匹配一个 十进制整数 。

  • 数字格式与 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 *
不适用
i

匹配 整型数 。

  • 数字格式与 strtol 函数所期望的格式相同，其中 ​ 0 ​ 作为 base 参数的值（进制由解析的首字符确定）。
u

匹配无符号 十进制整数 。

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

匹配无符号 八进制整数 。

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

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

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

返回 当前已读取的字符数 。

  • 不消耗输入。不增加赋值计数。
  • 若格式说明符定义了赋值抑制操作符，则行为未定义。
a (C99)
A (C99)
e
E
f
F (C99)
g
G

匹配 浮点数 。

  • 数字格式与 strtof 函数预期格式相同。
不适用 不适用
float *
double *
不适用 不适用 不适用 不适用
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 和 [ 除了存储匹配的字符外，始终会额外存储空终止符。目标数组的大小必须至少比指定字段宽度大1。若使用 % 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 。

注释

所有这些函数至少调用一次 va_arg ，返回后 arg 的值将变为未定义状态。这些函数不会调用 va_end ，必须由调用者完成该操作。

示例

运行此代码 
#include <stdio.h>
#include <stdbool.h>
#include <stdarg.h>
bool checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
    va_list ap;
    va_start(ap, fmt);
    int rc = vsscanf(buf, fmt, ap);
    va_end(ap);
    return rc == count;
}
int main(void)
{
    int n, m;
    printf("Parsing '1 2'...");
    if(checked_sscanf(2, "1 2", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
    printf("Parsing '1 a'...");
    if(checked_sscanf(2, "1 a", "%d %d", &n, &m))
        puts("success");
    else
        puts("failure");
}

输出： 

Parsing '1 2'...success
Parsing '1 a'...failure

参考文献

  • C11 标准 (ISO/IEC 9899:2011):
  • 7.21.6.9 vfscanf 函数 (页: 327)
  • 7.21.6.11 vscanf 函数 (页: 328)
  • 7.21.6.14 vsscanf 函数 (页: 330)
  • K.3.5.3.9 vfscanf_s 函数 (页: 597-598)
  • K.3.5.3.11 vscanf_s 函数 (页: 599)
  • K.3.5.3.14 vsscanf_s 函数 (页: 602)
  • C99 标准 (ISO/IEC 9899:1999):
  • 7.19.6.9 vfscanf 函数 (页: 293)
  • 7.19.6.11 vscanf 函数 (页: 294)
  • 7.19.6.14 vsscanf 函数 (页: 295)

另请参阅

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