| Types and objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Defined in header <stdio.h> | ||
int vscanf(constchar*restrict format, va_list vlist); | (1) | (since C99) |
int vfscanf(FILE*restrict stream,constchar*restrict format, va_list vlist); | (2) | (since C99) |
int vsscanf(constchar*restrict buffer,constchar*restrict format, va_list vlist); | (3) | (since C99) |
int vscanf_s(constchar*restrict format, va_list vlist); | (4) | (since C11) |
int vfscanf_s(FILE*restrict stream,constchar*restrict format, va_list vlist); | (5) | (since C11) |
int vsscanf_s(constchar*restrict buffer,constchar*restrict format, va_list vlist); | (6) | (since C11) |
Reads data from the a variety of sources, interprets it according toformat and stores the results into locations defined byvlist.
streambuffer. Reaching the end of the string is equivalent to reaching the end-of-file condition forfscanfformat,stream, orbuffer is a null pointervscanf_s,vfscanf_s, andvsscanf_s are only guaranteed to be available if__STDC_LIB_EXT1__ is defined by the implementation and if the user defines__STDC_WANT_LIB_EXT1__ to the integer constant1 before including<stdio.h>.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 |
| vlist | - | variable argument list containing the 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 C99→ | 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.
| |||||||||
xX | Matches an unsignedhexadecimal integer.
| |||||||||
n | Returns thenumber of characters read so far.
| |||||||||
a(C99)A(C99)eEfF(C99)gG | 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 callingisspace) 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 callingmbrtowc with anmbstate_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 asgets. The correct conversion specifications for thefixed-width integer types (int8_t, etc) are defined in the header 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. | ||||||||||
All these functions invokeva_arg at least once, the value ofarg is indeterminate after the return. These functions to not invokeva_end, and it must be done by the caller.
#include <stdio.h>#include <stdbool.h>#include <stdarg.h> bool checked_sscanf(int count,constchar* buf,constchar*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");elseputs("failure"); printf("Parsing '1 a'...");if(checked_sscanf(2,"1 a","%d %d",&n,&m))puts("success");elseputs("failure");}
Output:
Parsing '1 2'...successParsing '1 a'...failure
(C11)(C11)(C11) | reads formatted input fromstdin, a file stream or a buffer (function)[edit] |
(C99)(C11)(C11)(C11)(C11) | prints formatted output tostdout, a file stream or a buffer using variable argument list (function)[edit] |
C++ documentation forvscanf,vfscanf,vsscanf | |