命名空间
变体
操作

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 读取到单个 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

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

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

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

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

从 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*
N/A
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 期望的格式相同。
 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。

[编辑] 注意

所有这些函数都至少调用一次 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”