命名空间
变体
操作

vscanf, vfscanf, vsscanf, vscanf_s, vfscanf_s, vsscanf_s

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

格式化输入
vscanfvfscanfvsscanfvscanf_svfscanf_svsscanf_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

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

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

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

  • 如果使用宽度说明符，则匹配最多 *width* 个字符或直到第一个空白字符，以先出现的为准。
  • 除了匹配的字符外，始终存储一个空字符（因此参数数组必须至少有 *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*
不适用
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*
 不适用 不适用 不适用 不适用
long double*
p

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

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

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

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

转换说明符 lc、ls 和 l[ 执行多字节到宽字符转换，如同在转换第一个字符之前调用 mbrtowc 并将 mbstate_t 对象初始化为零一样。

转换说明符 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。

[编辑] 注意

所有这些函数至少调用一次 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 函数 (p: 327)
  • 7.21.6.11 vscanf 函数 (p: 328)
  • 7.21.6.14 vsscanf 函数 (p: 330)
  • K.3.5.3.9 vfscanf_s 函数 (p: 597-598)
  • K.3.5.3.11 vscanf_s 函数 (p: 599)
  • K.3.5.3.14 vsscanf_s 函数 (p: 602)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.19.6.9 vfscanf 函数 (p: 293)
  • 7.19.6.11 vscanf 函数 (p: 294)
  • 7.19.6.14 vsscanf 函数 (p: 295)

[编辑] 另请参阅

(C11)(C11)(C11)
 从 stdin、文件流或缓冲区读取格式化输入
(函数) [编辑]
(C99)(C11)(C11)(C11)(C11)
 将格式化输出打印到 stdout、文件流或缓冲区
使用可变参数列表
(函数) [编辑]
C++ 文档，关于 vscanf, vfscanf, vsscanf
取自“https://cppreference.cn/mwiki/index.php?title=c/io/vfscanf&oldid=125689”