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 读取单个字符时该值可为 1），并且以下错误会在运行时被检测到并调用当前安装的 约束处理函数 ：
  • 任何指针类型的参数是空指针
  • format 、 stream 或 buffer 是空指针
  • 通过 %c、%s 或 %[ 写入的字符数加上终止空字符会超过为这些转换说明符提供的第二个 (rsize_t) 参数
  • 可选地，任何其他可检测错误，例如未知转换说明符
与所有边界检查函数一样，仅当实现定义了 __STDC_LIB_EXT1__ 且用户在包含 <stdio.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整型常量 1 时，才保证 vscanf_s 、 vfscanf_s 和 vsscanf_s 可用。

目录

参数

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


format 字符串包含

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

以下格式说明符可用：

转换
说明符 		说明 期望的
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅自 C99 起可用→ 是 是 是 是 是
%
匹配字面量 % 。
不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用 不适用
c

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

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

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

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

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

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

匹配一个 整数 。

  • 数字的格式与 strtol 期望的相同，其中 base 参数的值为 ​ 0 ​ （基数由解析的第一个字符确定）。
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 期望的相同。
不适用 不适用
float *
double *
不适用

返回值

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