I/O manipulators | ||||
Print functions(C++23) | ||||
C-style I/O | ||||
Buffers | ||||
(C++23) | ||||
(C++98/26*) | ||||
(C++20) | ||||
Streams | ||||
Abstractions | ||||
File I/O | ||||
String I/O | ||||
Array I/O | ||||
(C++23) | ||||
(C++23) | ||||
(C++23) | ||||
(C++98/26*) | ||||
(C++98/26*) | ||||
(C++98/26*) | ||||
Synchronized Output | ||||
(C++20) | ||||
Types | ||||
Error category interface | ||||
(C++11) | ||||
(C++11) |
Types and objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Functions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Defined in header <cstdio> | ||
int scanf(constchar* format, ...); | (1) | |
int fscanf(std::FILE* stream,constchar* format, ...); | (2) | |
int sscanf(constchar* buffer,constchar* format, ...); | (3) | |
Reads data from a variety of sources, interprets it according toformat and stores the results into given locations.
Contents |
stream | - | input file stream to read from |
buffer | - | pointer to a null-terminated character string to read from |
format | - | pointer to a null-terminated character string specifying how to read the input |
... | - | receiving arguments |
Theformat string consists of
The following format specifiers are available:
Conversion specifier | Explanation | Expected Argument type | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Length Modifier→ | hh | h | none | l | ll | j | z | t | L | |
Only available since C++11→ | Yes | Yes | Yes | Yes | Yes | |||||
% | Matches literal % . | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
c | Matches acharacter or a sequence ofcharacters.
| N/A | N/A | char* | wchar_t* | N/A | N/A | N/A | N/A | N/A |
s | Matches a sequence of non-whitespace characters (astring).
| |||||||||
[ set ] | Matches a non-empty sequence of character fromset of characters.
| |||||||||
d | Matches adecimal integer.
| signedchar* orunsignedchar* | signedshort* orunsignedshort* | signedint* orunsignedint* | signedlong* orunsignedlong* | signedlonglong* orunsignedlonglong* | N/A | |||
i | Matches aninteger.
| |||||||||
u | Matches an unsigneddecimal integer.
| |||||||||
o | Matches an unsignedoctal integer.
| |||||||||
x X | Matches an unsignedhexadecimal integer.
| |||||||||
n | Returns thenumber of characters read so far.
| |||||||||
a (C++11)A (C++11)e E f F (C++11)g G | Matches afloating-point number.
| N/A | N/A | float* | double* | N/A | N/A | N/A | N/A | longdouble* |
p | Matches implementation defined character sequence defining apointer.
| N/A | N/A | void** | N/A | N/A | N/A | N/A | N/A | N/A |
Notes | ||||||||||
For every conversion specifier other thann, the longest sequence of input characters which does not exceed any specified field width and which either is exactly what the conversion specifier expects or is a prefix of a sequence it would expect, is what's consumed from the stream. The first character, if any, after this consumed sequence remains unread. If the consumed sequence has length zero or if the consumed sequence cannot be converted as specified above, the matching failure occurs unless end-of-file, an encoding error, or a read error prevented input from the stream, in which case it is an input failure. All conversion specifiers other than[,c, andn consume and discard all leading whitespace characters (determined as if by callingstd::isspace) before attempting to parse the input. These consumed characters do not count towards the specified maximum field width. The conversion specifierslc,ls, andl[ perform multibyte-to-wide character conversion as if by callingstd::mbrtowc with anstd::mbstate_t object initialized to zero before the first character is converted. The conversion specifierss and[ always store the null terminator in addition to the matched characters. The size of the destination array must be at least one greater than the specified field width. The use of%s or%[, without specifying the destination array size, is as unsafe asstd::gets. The correct conversion specifications for thefixed-width integer types (std::int8_t, etc) are defined in the header<cinttypes> (althoughSCNdMAX,SCNuMAX, etc is synonymous with%jd,%ju, etc). There is asequence point after the action of each conversion specifier; this permits storing multiple fields in the same “sink” variable. When parsing an incomplete floating-point value that ends in the exponent with no digits, such as parsing"100er" with the conversion specifier%f, the sequence"100e" (the longest prefix of a possibly valid floating-point number) is consumed, resulting in a matching error (the consumed sequence cannot be converted to a floating-point number), with"r" remaining. Some existing implementations do not follow this rule and roll back to consume only"100", leaving"er", e.g.,glibc bug 1765. If a conversion specification is invalid, the behavior is undefined. |
Number of receiving arguments successfully assigned (which may be zero in case a matching failure occurred before the first receiving argument was assigned), orEOF if input failure occurs before the first receiving argument was assigned.
Not guaranteed. Notably, some implementations ofstd::sscanf
areO(N), whereN=std::strlen(buffer)[1]. For performant string parsing, seestd::from_chars
.
Because most conversion specifiers first consume all consecutive whitespace, code such as
std::scanf("%d",&a);std::scanf("%d",&b);
will read two integers that are entered on different lines (second%d will consume the newline left over by the first) or on the same line, separated by spaces or tabs (second%d will consume the spaces or tabs).
The conversion specifiers that do not consume leading whitespace, such as%c, can be made to do so by using a whitespace character in the format string:std::scanf("%d",&a);std::scanf(" %c",&c);// ignore the endline after %d, then read a char
Note that some implementations ofstd::sscanf
involve a call tostd::strlen, which makes their runtime linear on the length of the entire string. This means that ifstd::sscanf
is called in a loop to repeatedly parse values from the front of a string, your code might run in quadratic time (example).
#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 conversionconstint 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';}
Output:
Converted 7 fields:i = 25x = 5.432str1 = Thompsonj = 56y = 789str2 = 56warr[0] = U+dfwarr[1] = U+6c34
(C++11)(C++11)(C++11) | reads formatted input fromstdin, a file stream or a buffer using variable argument list (function)[edit] |
gets a character string from a file stream (function)[edit] | |
(C++11) | prints formatted output tostdout, a file stream or a buffer (function)[edit] |
(C++17) | converts a character sequence to an integer or floating-point value (function)[edit] |
C documentation forscanf,fscanf,sscanf |