名稱空間
變體
操作

std::scanf, std::fscanf, std::sscanf

來自 cppreference.com
< cpp‎ | io‎ | c
 
C++
 
輸入/輸出庫
 
C 風格 I/O
型別和物件
函式
檔案訪問
直接輸入/輸出
非格式化輸入/輸出
格式化輸入
scanffscanfsscanf
(C++11)(C++11)(C++11)    
(C++11)(C++11)(C++11)    
 
定義於標頭檔案 <cstdio>
int scanf( const char* format, ... );
 (1)
int fscanf( std::FILE* stream, const char* format, ... );
 (2)
int sscanf( const char* buffer, const char* format, ... );
 (3)

從各種來源讀取資料，根據 format 進行解釋並將結果儲存到給定位置。

1) 從 stdin 讀取資料。
2) 從檔案流 stream 讀取資料。
3) 從以 null 結尾的字串 buffer 讀取資料。

目錄

[編輯] 引數

stream - 要從中讀取的輸入檔案流
buffer - 指向要從中讀取的以空字元結尾的字串的指標
format - 指向以空字元結尾的字串的指標，指定如何讀取輸入
... - 接收引數

format 字串由以下部分組成：

  • 非空白多位元組字元，除了 %：格式字串中每個此類字元都會從輸入流中消耗恰好一個相同的字元，如果流中的下一個字元不相等，則會導致函式失敗。
  • 空白字元：格式字串中的任何單個空白字元都會從輸入中消耗所有可用的連續空白字元（透過迴圈呼叫 std::isspace 確定）。請注意，格式字串中的 "\n"、" "、"\t\t" 或其他空白沒有區別。
  • 轉換說明符。每個轉換說明符具有以下格式：
  • 起始的 % 字元。
  • (可選) 賦值抑制字元 *。如果存在此選項，則函式不會將轉換結果賦值給任何接收引數。
  • (可選) 整數（大於零），指定 *最大欄位寬度*，即函式在執行當前轉換規範指定的轉換時允許消耗的最大字元數。請注意，如果未提供寬度，%s 和 %[ 可能會導致緩衝區溢位。
  • (可選) *長度修飾符*，指定接收引數的大小，即實際目標型別。這會影響轉換精度和溢位規則。預設目標型別對於每種轉換型別都不同（見下表）。
  • 轉換格式說明符。

以下格式說明符可用：

轉換
說明符		 解釋 預期
引數型別
長度修飾符→ hh h 無 l ll j z t L
僅自 C++11 起可用→ 是 是 是 是 是
%
匹配字面量 `%`。
 不適用 不適用 不適用 不適用 不適用 不適用 不適用 不適用 不適用
c

匹配一個字元或一系列字元。

  • 如果使用寬度說明符，則精確匹配 *width* 個字元（引數必須是指向具有足夠空間的陣列的指標）。
  • 與 %s 和 %[ 不同，不會在陣列末尾新增空字元。
 不適用 不適用
char*
wchar_t*
 不適用 不適用 不適用 不適用 不適用
s

匹配一系列非空白字元（一個字串）。

  • 如果使用寬度說明符，則匹配最多 *width* 個字元或直到第一個空白字元，以先出現的為準。
  • 除了匹配的字元外，始終儲存一個空字元（因此引數陣列必須至少有 *width+1* 個字元的空間）。
[set ]

匹配來自字元 set 的非空字元序列。

  • 如果集合的第一個字元是 `^`，則匹配集合中不包含的所有字元。
  • 如果集合以 `]` 或 `^]` 開頭，則 `]` 字元也包含在集合中。
  • 在掃描集中非起始位置的字元 `-` 是否表示範圍（如 `[0-9]`）是實現定義的。
  • 如果使用寬度說明符，則只匹配最多 *width* 個字元。
  • 除了匹配的字元外，始終儲存一個空字元（因此引數陣列必須至少有 *width+1* 個字元的空間）。
d

匹配一個十進位制整數。

  • 數字的格式與 std::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

匹配一個整數。

  • 數字的格式與 std::strtol 期望的相同，其中 base 引數的值為 ​0​（基數由解析的第一個字元確定）。
u

匹配一個無符號十進位制整數。

  • 數字的格式與 std::strtoul 期望的相同，其中 base 引數的值為 10。
o

匹配一個無符號八進位制整數。

  • 數字的格式與 std::strtoul 期望的相同，其中 base 引數的值為 8。
x
X

匹配一個無符號十六進位制整數。

  • 數字的格式與 std::strtoul 期望的相同，其中 base 引數的值為 16。
n

返回目前讀取的字元數。

  • 不消耗輸入。不增加賦值計數。
  • 如果說明符定義了賦值抑制運算子，則行為是未定義的。
a (C++11)
A (C++11)
e
E
f
F (C++11)
g
G

匹配一個浮點數。

 不適用 不適用
float*
double*
 不適用 不適用 不適用 不適用
long double*
p

匹配定義指標的實現定義的字元序列。

  • `printf` 函式族應使用 `%p` 格式說明符生成相同的序列。
 不適用 不適用
void**
 不適用 不適用 不適用 不適用 不適用 不適用
注意

對於除了 n 之外的所有轉換說明符，將消耗不超過指定欄位寬度且與轉換說明符預期完全相同或為其字首的最長輸入字元序列。此消耗序列之後的第一個字元（如果有）保持未讀。如果消耗序列的長度為零，或者消耗序列無法按照上述指定進行轉換，則會發生匹配失敗，除非檔案結束、編碼錯誤或讀取錯誤阻止了流輸入，在這種情況下，它是一個輸入失敗。

除了 [、c 和 n 之外的所有轉換說明符，在嘗試解析輸入之前，都會消耗並丟棄所有前導空白字元（透過呼叫 std::isspace 確定）。這些消耗的字元不計入指定的最大欄位寬度。

轉換說明符 lc、ls 和 l[ 執行多位元組到寬字元的轉換，就像在轉換第一個字元之前，使用初始化為零的 std::mbstate_t 物件呼叫 std::mbrtowc 一樣。

轉換說明符 s 和 [ 除了匹配的字元外，總是儲存空終止符。目標陣列的大小必須至少比指定欄位寬度大一。使用 %s 或 %[ 而不指定目標陣列大小，與 std::gets 一樣不安全。

固定寬度整數型別（std::int8_t 等）的正確轉換規範在標頭檔案 <cinttypes> 中定義（儘管 SCNdMAX、SCNuMAX 等與 %jd、%ju 等同義）。

每個轉換說明符的操作之後都有一個序列點；這允許將多個欄位儲存在同一個“接收”變數中。

當解析以指數結尾且沒有數字的不完整浮點值時，例如使用轉換說明符 %f 解析 "100er" 時，序列 "100e"（可能是有效浮點數的最長字首）被消耗，導致匹配錯誤（消耗的序列無法轉換為浮點數），並留下 "r"。一些現有實現不遵循此規則，並回滾以僅消耗 "100"，留下 "er"，例如 glibc bug 1765。

如果轉換說明符無效，則行為未定義。

[編輯] 返回值

成功賦值的接收引數的數量（如果在賦值第一個接收引數之前發生匹配失敗，則可能為零），或者如果在賦值第一個接收引數之前發生輸入失敗，則為 EOF。

[編輯] 複雜度

不保證。值得注意的是，一些 std::sscanf 的實現是 O(N)，其中 N = std::strlen(buffer) [1]。對於高效能字串解析，請參閱 std::from_chars。

[編輯] 注意

因為大多數轉換說明符首先消耗所有連續的空白，所以如下程式碼

std::scanf("%d", &a);
std::scanf("%d", &b);

將讀取在不同行（第二個 %d 將消耗第一個留下的換行符）或在同一行中由空格或製表符分隔的兩個整數（第二個 %d 將消耗空格或製表符）。

不消耗前導空白的轉換說明符，例如 %c，可以透過在格式字串中使用空白字元來使其消耗前導空白
std::scanf("%d", &a);
std::scanf(" %c", &c); // ignore the endline after %d, then read a char

請注意，某些 std::sscanf 的實現涉及到呼叫 std::strlen，這使得它們的執行時與整個字串的長度呈線性關係。這意味著如果 std::sscanf 在迴圈中被呼叫以重複從字串開頭解析值，您的程式碼可能會以二次時間執行（示例）。

[編輯] 示例

執行此程式碼
#include <clocale>
#include <cstdio>
#include <iostream>
 
int main()
{
    int i, j;
    float x, y;
    char str1[10], str2[4];
    wchar_t warr[2];
    std::setlocale(LC_ALL, "en_US.utf8");
 
    char input[] = "25 54.32E-1 Thompson 56789 0123 56ß水";
    // parse as follows:
    // %d: an integer 
    // %f: a floating-point value
    // %9s: a string of at most 9 non-whitespace characters
    // %2d: two-digit integer (digits 5 and 6)
    // %f: a floating-point value (digits 7, 8, 9)
    // %*d an integer which isn't stored anywhere
    // ' ': all consecutive whitespace
    // %3[0-9]: a string of at most 3 digits (digits 5 and 6)
    // %2lc: two wide characters, using multibyte to wide conversion
    const int ret = std::sscanf(input, "%d%f%9s%2d%f%*d %3[0-9]%2lc",
                                &i, &x, str1, &j, &y, str2, warr);
 
    std::cout << "Converted " << ret << " fields:\n"
                 "i = " << i << "\n"
                 "x = " << x << "\n"
                 "str1 = " << str1 << "\n"
                 "j = " << j << "\n"
                 "y = " << y << "\n"
                 "str2 = " << str2 << std::hex << "\n"
                 "warr[0] = U+" << (int)warr[0] << "\n"
                 "warr[1] = U+" << (int)warr[1] << '\n';
}

輸出

Converted 7 fields:
i = 25
x = 5.432
str1 = Thompson
j = 56
y = 789
str2 = 56
warr[0] = U+df
warr[1] = U+6c34

[編輯] 另請參閱

(C++11)(C++11)(C++11)
 從 stdin、檔案流或緩衝區讀取格式化輸入
使用可變引數列表
(函式) [編輯]
 從檔案流獲取字元字串
(函式) [編輯]
(C++11)
 將格式化輸出列印到 stdout、檔案流或緩衝區
(函式) [編輯]
(C++17)
 將字元序列轉換為整數或浮點值
(函式) [編輯]
C 文件 用於 scanf, fscanf, sscanf
取自 "https://cppreference.tw/mwiki/index.php?title=cpp/io/c/fscanf&oldid=158702"