Namespaces
Variants

std:: wscanf, std:: fwscanf, std:: swscanf

From zh.cppreference.net
< cpp ‎ | io ‎ | c
定义于头文件 <cwchar>
int wscanf ( const wchar_t * format, ... ) ;
(1)
int fwscanf ( std:: FILE * stream, const wchar_t * format, ... ) ;
(2)
int swscanf ( const wchar_t * buffer, const wchar_t * format, ... ) ;
(3)

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

1) 从 stdin 读取数据。
2) 从文件流 stream 中读取数据。
3) 从以空字符结尾的宽字符串 buffer 中读取数据。

内容

参数

stream - 从中读取的输入文件流
buffer - 指向要读取的空终止宽字符串的指针
format - 指向指定如何读取输入的空终止宽字符串的指针
... - 接收参数。


格式字符串由以下部分组成:

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

可用的格式说明符如下:

转换
说明符
解释 期望
参数类型
长度修饰符→ hh h 无 l ll j z t L
仅自C++11起可用→ 是 是 是 是 是
%
匹配字面%。
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个字符的空间)。
[集合 ]

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

  • 如果集合的第一个字符是^,则匹配所有不在集合中的字符。
  • 如果集合以]或^]开头,则]字符也包含在集合中。
  • 扫描集中非初始位置的字符-是否可能表示范围(如[0-9])是由实现定义的。
  • 如果使用了宽度说明符,则最多匹配宽度个字符。
  • 除了匹配的字符外,始终存储一个空字符(因此参数数组必须至少有宽度+1个字符的空间)。
d

匹配一个十进制整数。

  • 数字的格式与std::wcstol期望的相同,其中10参数值为base。
signed char*或unsigned char*
signed short*或unsigned short*
signed int*或unsigned int*
signed long*或unsigned long*
signed long long*或unsigned long long*
std::intmax_t*或std::uintmax_t*
std::size_t*
std::ptrdiff_t*
N/A
b (C++26)

匹配一个无符号二进制整数。

  • 数字的格式与std::wcstoul期望的相同,其中2参数值为base。
i

匹配一个整数。

  • 数字的格式与std::wcstol期望的相同,其中0参数值为base(基数由解析的第一个字符确定)。
u

匹配一个无符号十进制整数。

  • 数字的格式与std::wcstoul期望的相同,其中10参数值为base。
o

匹配一个无符号八进制整数。

  • 数字的格式与std::wcstoul期望的相同,其中8参数值为base。
x
X

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

  • 数字的格式与std::wcstoul期望的相同,其中16参数值为base。
n

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

  • 不消耗输入。不增加赋值计数。
  • 如果说明符定义了赋值抑制操作符,则行为未定义。
a (C++11)
A (C++11)
e
E
f
F (C++11)
g
G

匹配一个浮点数。

  • 数字的格式与std::wcstof期望的相同。
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之外的所有转换说明符,消耗的输入字符序列是最长的、不超过任何指定字段宽度,并且要么与转换说明符期望的完全一致,要么是它期望序列的前缀。此消耗序列之后的第一个字符(如果有)保持未读状态。如果消耗序列长度为零,或者消耗的序列无法按上述方式转换,则发生匹配失败,除非文件结束、编码错误或读取错误阻止了从流中输入,在这种情况下是输入失败。

除了%说明符外,输入项(或对于%n,输入字符的计数)首先被转换为适合转换说明符的类型。除非已使用*抑制赋值,否则转换结果将被写入下一个尚未写入的参数所指向的对象。如果该对象没有合适的类型,或者转换结果无法在该对象中表示,则行为未定义。

除了[、c和n之外的所有转换说明符在尝试解析输入之前,都会消耗并丢弃所有前导空白字符(如同通过调用std::iswspace确定)。这些消耗的字符不计入指定的最大字段宽度。

如果未使用长度说明符l,则转换说明符c、s和[执行宽字符到多字节字符的转换,如同在转换第一个字符之前使用初始化为零的std::mbstate_t对象调用std::wcrtomb。

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

用于定宽整数类型(std::int8_t等)的正确转换说明符在头文件<cinttypes>中定义(尽管SCNdMAX、SCNuMAX等与%jd、%ju等同义)。

每个转换说明符的动作之后有一个序列点;这允许将多个字段存储到同一个“接收”变量中。

当解析一个不完整的浮点值(以指数结尾但没有数字)时,例如使用转换说明符"100er"解析%f,序列"100e"(可能是有效浮点数的最长前缀)被消耗,导致匹配错误(消耗的序列无法转换为浮点数),而"r"保留。一些现有实现不遵循此规则,而是回退到仅消耗"100",留下"er",例如glibc bug 1765。

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

返回值

成功读取的参数数量,若在首个接收参数被赋值前发生失败则返回 EOF 。

示例

另请参阅

(C++11) (C++11) (C++11)
从 标准输入 、文件流或缓冲区读取格式化宽字符输入
使用可变参数列表
(函数)
C 文档 关于 wscanf 、 fwscanf 、 swscanf