NAME¶

std::vscanf,std::vfscanf,std::vsscanf - std::vscanf,std::vfscanf,std::vsscanf

Synopsis¶

Defined in header <cstdio>
int vscanf( const char* format, va_list vlist ); (1) (since C++11)
int vfscanf( std::FILE* stream, const char* format, va_list vlist (2) (since C++11)
);
int vsscanf( const char* buffer, const char* format, va_list vlist (3) (since C++11)
);

Reads data from the a variety of sources, interprets it according to format and
stores the results into locations defined by vlist.

1) Reads the data from stdin.
2) Reads the data from file stream stream.
3) Reads the data from null-terminated character string buffer.

Parameters¶

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.

The format string consists of

* non-whitespace multibyte characters except %: each such character in the format
string consumes exactly one identical character from the input stream, or causes
the function to fail if the next character on the stream does not compare equal.
* whitespace characters: any single whitespace character in the format string
consumes all available consecutive whitespace characters from the input
(determined as if by calling isspace in a loop). Note that there is no
difference between "\n", " ", "\t\t", or other whitespace in the format string.
* conversion specifications. Each conversion specification has the following
format:

* introductory % character

* (optional) assignment-suppressing character *. If this option is
present, the function does not assign the result of the conversion to
any receiving argument.

* (optional) integer number (greater than zero) that specifies maximum
field width, that is, the maximum number of characters that the
function is allowed to consume when doing the conversion specified by
the current conversion specification. Note that %s and %[ may lead to
buffer overflow if the width is not provided.

* (optional) length modifier that specifies the size of the receiving
argument, that is, the actual destination type. This affects the
conversion accuracy and overflow rules. The default destination type is
different for each conversion type (see table below).

* conversion format specifier

The following format specifiers are available:

Conversion Explanation Argument type specifier
hh ll j z t
Length modifier → h (none) l L
(C++11) (C++11) (C++11) (C++11) (C++11)
% matches literal % N/A N/A N/A N/A N/A N/A N/A N/A N/A
matches a character
or a sequence of
characters

If a width specifier
is used, matches
exactly width
c characters (the
argument must be a
pointer to an array
with sufficient room).
Unlike %s and %[, does
not append the null
character to the
array.
matches a sequence
of non-whitespace
characters (a
string)

If width specifier is
used, matches up to
width or until the
s first whitespace
character, whichever
appears first. Always
stores a null
character in addition
to the characters
matched (so the
argument array must
have room for at least N/A N/A char* wchar_t* N/A N/A N/A N/A N/A
width+1 characters)
matches a non-empty
sequence of
character from set
of characters.

If the first character
of the set is ^, then
all characters not in
the set are matched.
If the set begins with
] or ^] then the ]
character is also
included into the set.
It is
implementation-defined
[set] whether the character
- in the non-initial
position in the
scanset may be
indicating a range, as
in [0-9]. If width
specifier is used,
matches only up to
width. Always stores a
null character in
addition to the
characters matched (so
the argument array
must have room for at
least width+1
characters)
matches a decimal
integer.

d The format of the
number is the same as
expected by strtol
with the value 10 for
the base argument
matches an integer.

The format of the
number is the same as
i expected by strtol
with the value 0
for the base argument
(base is determined by
the first characters
parsed)
matches an unsigned
decimal integer.

u The format of the
number is the same as
expected by strtoul
with the value 10 for signed signed
the base argument. signed short* signed signed long intmax_t*
matches an unsigned char* or or int* or long* or long* or or size_t* ptrdiff_t* N/A
octal integer. unsigned unsigned unsigned unsigned unsigned uintmax_t*
char* short* int* long* long
o The format of the long*
number is the same as
expected by strtoul
with the value 8 for
the base argument
matches an unsigned
hexadecimal
integer.

x, X The format of the
number is the same as
expected by strtoul
with the value 16 for
the base argument
returns the number
of characters read
so far.

No input is consumed.
n Does not increment the
assignment count. If
the specifier has
assignment-suppressing
operator defined, the
behavior is undefined
matches a
a, floating-point
A(C++11) number. long
e, E N/A N/A float* double* N/A N/A N/A N/A double*
f, F The format of the
g, G number is the same as
expected by strtof
matches
implementation
defined character
sequence defining a
pointer.
p N/A N/A void** N/A N/A N/A N/A N/A N/A
printf family of
functions should
produce the same
sequence using %p
format specifier

For every conversion specifier other than n, 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, and n consume and discard all leading
whitespace characters (determined as if by calling isspace) before attempting to
parse the input. These consumed characters do not count towards the specified
maximum field width.

The conversion specifiers lc, ls, and l[ perform multibyte-to-wide character
conversion as if by calling mbrtowc with an mbstate_t object initialized to zero
before the first character is converted.

The conversion specifiers s 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 as std::gets.

The correct conversion specifications for the fixed-width integer types (int8_t,
etc) are defined in the header <cinttypes> (although SCNdMAX, SCNuMAX, etc is
synonymous with %jd, %ju, etc).

There is a sequence 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

Return value¶

Number of arguments successfully read, or EOF if failure occurs.

Notes¶

All these functions invoke va_arg at least once, the value of arg is indeterminate
after the return. These functions to not invoke va_end, and it must be done by the
caller.

Example¶

// Run this code

#include <iostream>
#include <cstdio>
#include <cstdarg>
#include <stdexcept>

void checked_sscanf(int count, const char* buf, const char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
if(std::vsscanf(buf, fmt, ap) != count)
throw std::runtime_error("parsing error");
va_end(ap);
}

int main()
{
try {
int n, m;
std::cout << "Parsing '1 2'...";
checked_sscanf(2, "1 2", "%d %d", &n, &m);
std::cout << "success\n";
std::cout << "Parsing '1 a'...";
checked_sscanf(2, "1 a", "%d %d", &n, &m);
std::cout << "success\n";
} catch(const std::exception& e) {
std::cout << e.what() << '\n';
}
}

Output:¶

Parsing '1 2'...success
Parsing '1 a'...parsing error

See also¶

scanf reads formatted input from stdin, a file stream or a buffer
fscanf (function)
sscanf
vprintf
vfprintf prints formatted output to stdout, a file stream or a buffer
vsprintf using variable argument list
vsnprintf (function)
(C++11)