命名空间
变体
操作

wscanf, fwscanf, swscanf, wscanf_s, fwscanf_s, swscanf_s

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

格式化输入
(C11)(C11)(C11)
wscanffwscanfswscanfwscanf_sfwscanf_sswscanf_s
(C95)(C95)(C95)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)
(C99)(C99)(C99)(C11)(C11)(C11)  
 
定义于头文件 <wchar.h>
(1)
int wscanf( const wchar_t *format, ... );
 (始于 C95)
(直到 C99)
int wscanf( const wchar_t *restrict format, ... );
 (始于 C99)
(2)
int fwscanf( FILE *stream, const wchar_t *format, ... );
 (始于 C95)
(直到 C99)
int fwscanf( FILE *restrict stream,
             const wchar_t *restrict format, ... );
 (始于 C99)
(3)
int swscanf( const wchar_t *buffer, const wchar_t *format, ... );
 (始于 C95)
(直到 C99)
int swscanf( const wchar_t *restrict buffer,
             const wchar_t *restrict format, ... );
 (始于 C99)
int wscanf_s( const wchar_t *restrict format, ...);
 (4) (始于 C11)
int fwscanf_s( FILE *restrict stream,
               const wchar_t *restrict format, ...);
 (5) (始于 C11)
int swscanf_s( const wchar_t *restrict s,
               const wchar_t *restrict format, ...);
 (6) (始于 C11)

从多种来源读取数据，根据 format 解释数据，并将结果存储到指定位置。

1) 从 stdin 读取数据。
2) 从文件流 stream 读取数据。
3) 从空字符结尾的宽字符串 buffer 读取数据。到达字符串末尾等同于 fwscanf 达到文件结束条件
4-6) 与 (1-3) 相同，除了 %c、 %s 和 %[ 转换说明符都期望两个参数（通常的指针和一个 rsize_t 类型的值，指示接收数组的大小，当使用 %lc 读取到单个宽字符时，该值可能为 1），并且除了在运行时检测到以下错误并调用当前安装的 约束处理函数
  • 任何指针类型的参数为空指针
  • format、 stream 或 buffer 为空指针
  • %c、 %s 或 %[ 将写入的字符数加上终止空字符，将超过为每个转换说明符提供的第二个 (rsize_t) 参数
  • 可选地，任何其他可检测到的错误，例如未知的转换说明符
作为所有边界检查函数，仅当实现定义了 __STDC_LIB_EXT1__ 并且用户在包含 <wchar.h> 之前将 __STDC_WANT_LIB_EXT1__ 定义为整数常量 1 时，才能保证 wscanf_s、 fwscanf_s 和 swscanf_s 可用。

内容

[编辑] 参数

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


format 字符串由以下部分组成

  • 非空白宽字符，除了 %：format 字符串中的每个此类字符都从输入流中消耗一个完全相同的字符，或者如果流中的下一个字符不相等，则导致函数失败。
  • 空白字符：format 字符串中的任何单个空白字符都会消耗输入中所有可用的连续空白字符（如同在循环中调用 iswspace 确定）。请注意，format 字符串中的 "\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

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

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

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

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

匹配十进制整数。

  • 数字的格式与 wcstol 期望的格式相同，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

匹配整数。

  • 数字的格式与 wcstol 期望的格式相同，base 参数的值为 ​0​ （base 由解析的第一个字符确定）。
u

匹配无符号十进制整数。

  • 数字的格式与 wcstoul 期望的格式相同，base 参数的值为 10。
o

匹配无符号八进制整数。

  • 数字的格式与 wcstoul 期望的格式相同，base 参数的值为 8。
x
X

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

  • 数字的格式与 wcstoul 期望的格式相同，base 参数的值为 16。
n

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

  • 不消耗任何输入。不增加赋值计数。
  • 如果说明符定义了赋值抑制运算符，则行为未定义。
a (C99)
A (C99)
e
E
f
F (C99)
g
G

匹配浮点数。

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

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

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

转换说明符 s 和 [ 始终存储空终止符以及匹配的字符。目标数组的大小必须至少比指定的字段宽度大 1。在不指定目标数组大小的情况下使用 %s 或 %[ 与 gets 一样不安全。

固定宽度整数类型（int8_t 等）的正确转换说明符在头文件 <inttypes.h> 中定义（尽管 SCNdMAX、 SCNuMAX 等与 %jd、 %ju 等同义）。

在每个转换说明符的操作之后都有一个序列点；这允许在同一个“sink”变量中存储多个字段。

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

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

[编辑] 返回值

1-3) 成功赋值的接收参数的数量；如果在第一个接收参数赋值之前发生读取失败，则为 EOF。
4-6) 与 (1-3) 相同，除了如果存在运行时约束冲突，也会返回 EOF。

[编辑] 示例

运行此代码
#include <stdio.h>
#include <wchar.h>
#include <string.h>
 
#define NUM_VARS   3
#define ERR_READ   2
#define ERR_WRITE  3
 
int main(void) {
    wchar_t state[64];
    wchar_t capital[64];
    unsigned int population = 0;
    int elevation = 0;
    int age = 0;
    float pi = 0;
 
#if INTERACTIVE_MODE
    wprintf(L"Enter state, age, and pi value: ");
    if (wscanf(L"%ls%d%f", state, &age, &pi) != NUM_VARS) {
        fprintf(stderr, "Error reading input.\n");
        return ERR_READ;
    }
#else
    wchar_t* input = L"California 170 3.141592";
    if (swscanf(input, L"%ls%d%f", state, &age, &pi) != NUM_VARS) {
        fprintf(stderr, "Error reading input.\n");
        return ERR_READ;
    }
#endif
    wprintf(L"State: %ls\nAge  : %d years\nPi   : %.5f\n\n", state, age, pi);
 
    FILE* fp = tmpfile();
    if (fp) {
        // write some data to temp file
        if (!fwprintf(fp, L"Mississippi Jackson 420000 807")) {
            fprintf(stderr, "Error writing to file.\n");
            fclose(fp);
            return ERR_WRITE;
        }
        // rewind file pointer
        rewind(fp);
 
        // read data into variables
        fwscanf(fp, L"%ls%ls%u%d", state, capital, &population, &elevation);
        wprintf(L"State  : %ls\nCapital: %ls\nJackson population (in 2020): %u\n"
                L"Highest elevation: %dft\n",
                state, capital, population, elevation);
        fclose(fp);
    }
}

可能的输出

State: California
Age  : 170 years
Pi   : 3.14159
 
State  : Mississippi
Capital: Jackson
Jackson population (in 2020): 420000
Highest elevation: 807ft

[编辑] 参考

  • C11 标准 (ISO/IEC 9899:2011)
  • 7.29.2.2 fwscanf 函数 (p: 410-416)
  • 7.29.2.4 swscanf 函数 (p: 417)
  • 7.29.2.12 wscanf 函数 (p: 421)
  • K.3.9.1.2 fwscanf_s 函数 (p: 628-629)
  • K.3.9.1.5 swscanf_s 函数 (p: 631)
  • K.3.9.1.14 wscanf_s 函数 (p: 638)
  • C99 标准 (ISO/IEC 9899:1999)
  • 7.24.2.2 fwscanf 函数 (p: 356-362)
  • 7.24.2.4 swscanf 函数 (p: 362)
  • 7.24.2.12 wscanf 函数 (p: 366-367)

[编辑] 参见

(C99)(C99)(C99)(C11)(C11)(C11)
 从 stdin、文件流读取格式化的宽字符输入
或使用可变参数列表的缓冲区
(函数) [编辑]
C++ 文档 for wscanf, fwscanf, swscanf
取自 "https://cppreference.cn/mwiki/index.php?title=c/io/fwscanf&oldid=140800"