Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
sscanf(3)
Edit
PageHistory
Diff
Info
LikePages
SCANF !!!SCANF NAME SYNOPSIS DESCRIPTION CONVERSIONS RETURN VALUE SEE ALSO CONFORMING TO BUGS ---- !!NAME scanf, fscanf, sscanf, vscanf, vsscanf, vfscanf - input format conversion !!SYNOPSIS __#include __''format''__, ...__''); ''__int fscanf( FILE *__''stream''__, const char *__''format''__, ...__''); ''__int sscanf( const char *__''str''__, const char *__''format''__, ...__''); ''__#include __''format''__, va_list__ ''ap''__); int vsscanf( const char *__''str''__, const char *__''format''__, va_list__ ''ap''__); int vfscanf( FILE *__''stream''__, const char *__''format''__, va_list__ ''ap''__); __ !!DESCRIPTION The __scanf__ family of functions scans input according to a ''format'' as described below. This format may contain ''conversion specifiers''; the results from such conversions, if any, are stored through the ''pointer'' arguments. The __scanf__ function reads input from the standard input stream ''stdin'', __fscanf__ reads input from the stream pointer ''stream'', and __sscanf__ reads its input from the character string pointed to by ''str''. The __vfscanf__ function is analogous to vfprintf(3) and reads input from the stream pointer ''stream'' using a variable argument list of pointers (see stdarg(3). The __vscanf__ function scans a variable argument list from the standard input and the __vsscanf__ function scans it from a string; these are analogous to the __vprintf__ and __vsprintf__ functions respectively. Each successive ''pointer'' argument must correspond properly with each successive conversion specifier (but see `suppression' below). All conversions are introduced by the __%__ (percent sign) character. The ''format'' string may also contain other characters. White space (such as blanks, tabs, or newlines) in the ''format'' string match any amount of white space, including none, in the input. Everything else matches only itself. Scanning stops when an input character does not match such a format character. Scanning also stops when an input conversion cannot be made (see below). !!CONVERSIONS Following the __%__ character introducing a conversion there may be a number of ''flag'' characters, as follows: __*__ Suppresses assignment. The conversion that follows occurs as usual, but no pointer is used; the result of the conversion is simply discarded. __a__ Indicates that the conversion will be __s__, the needed memory space for the string will be malloc'ed and the pointer to it will be assigned to the ''char'' pointer variable, which does not have to be initialised before. This flag does not exist in ''ANSI C''. __h__ Indicates that the conversion will be one of __dioux__ or __n__ and the next pointer is a pointer to a ''short int'' (rather than ''int''). __l__ Indicates either that the conversion will be one of __dioux__ or __n__ and the next pointer is a pointer to a ''long int'' (rather than ''int''), or that the conversion will be one of __efg__ and the next pointer is a pointer to ''double'' (rather than ''float''). Specifying two __l__ flags is equivalent to the __L__ flag. __L__ Indicates that the conversion will be either __efg__ and the next pointer is a pointer to ''long double'' or the conversion will be __dioux__ and the next pointer is a pointer to ''long long''. (Note that long long is not an ''ANSI C'' type. Any program using this will not be portable to all architectures). __q__ equivalent to L. This flag does not exist in ''ANSI C''. In addition to these flags, there may be an optional maximum field width, expressed as a decimal integer, between the __%__ and the conversion. If no width is given, a default of `infinity' is used (with one exception, below); otherwise at most this many characters are scanned in processing the conversion. Before conversion begins, most conversions skip white space; this white space is not counted against the field width. The following conversions are available: __%__ Matches a literal `%'. That is, `%%' in the format string matches a single input `%' character. No conversion is done, and assignment does not occur. __d__ Matches an optionally signed decimal integer; the next pointer must be a pointer to ''int''. __D__ Equivalent to __ld__; this exists only for backwards compatibility. (Note: thus only in libc4. In libc5 and glibc the %D is silently ignored, causing old programs to fail mysteriously.) __i__ Matches an optionally signed integer; the next pointer must be a pointer to ''int''. The integer is read in base 16 if it begins with `0x' or `0X', in base 8 if it begins with `0', and in base 10 otherwise. Only characters that correspond to the base are used. __o__ Matches an unsigned octal integer; the next pointer must be a pointer to ''unsigned int''. __u__ Matches an unsigned decimal integer; the next pointer must be a pointer to ''unsigned int''. __x__ Matches an unsigned hexadecimal integer; the next pointer must be a pointer to ''unsigned int''. __X__ Equivalent to __x__ __f__ Matches an optionally signed floating-point number; the next pointer must be a pointer to ''float''. __e__ Equivalent to __f__. __g__ Equivalent to __f__. __E__ Equivalent to __f__ __s__ Matches a sequence of non-white-space characters; the next pointer must be a pointer to ''char'', and the array must be large enough to accept all the sequence and the terminating __NUL__ character. The input string stops at white space or at the maximum field width, whichever occurs first. __c__ Matches a sequence of ''width'' count characters (default 1); the next pointer must be a pointer to ''char'', and there must be enough room for all the characters (no terminating __NUL__ is added). The usual skip of leading white space is suppressed. To skip white space first, use an explicit space in the format. __[[__ Matches a nonempty sequence of characters from the specified set of accepted characters; the next pointer must be a pointer to ''char'', and there must be enough room for all the characters in the string, plus a terminating __NUL__ character. The usual skip of leading white space is suppressed. The string is to be made up of characters in (or not in) a particular set; the set is defined by the characters between the open bracket __[[__ character and a close bracket __]__ character. The set ''excludes'' those characters if the first character after the open bracket is a circumflex __^__. To include a close bracket in the set, make it the first character after the open bracket or the circumflex; any other position will end the set. The hyphen character __-__ is also special; when placed between two other characters, it adds all intervening characters to the set. To include a hyphen, make it the last character before the final close bracket. For instance, `[[^]0-9-]' means the set `everything except close bracket, zero through nine, and hyphen'. The string ends with the appearance of a character not in the (or, with a circumflex, in) set or when the field width runs out. __p__ Matches a pointer value (as printed by `%p' in printf(3); the next pointer must be a pointer to ''void''. __n__ Nothing is expected; instead, the number of characters consumed thus far from the input is stored through the next pointer, which must be a pointer to ''int''. This is ''not'' a conversion, although it can be suppressed with the __*__ flag. The C standard says: `Execution of a %n directive does not increment the assignment count returned at the completion of execution' but the Corrigendum seems to contradict this. Probably it is wise not to make any assumptions on the effect of %n conversions on the return value. !!RETURN VALUE These functions return the number of input items assigned, which can be fewer than provided for, or even zero, in the event of a matching failure. Zero indicates that, while there was input available, no conversions were assigned; typically this is due to an invalid input character, such as an alphabetic character for a `%d' conversion. The value __EOF__ is returned if an input failure occurs before any conversion such as an end-of-file occurs. If an error or end-of-file occurs after conversion has begun, the number of conversions which were successfully completed is returned. !!SEE ALSO strtol(3), strtoul(3), strtod(3), getc(3), printf(3) !!CONFORMING TO The functions __fscanf__, __scanf__, and __sscanf__ conform to ANSI X3.159-1989 (``ANSI C''). The __q__ flag is the ''BSD 4.4'' notation for ''long long'', while __ll__ or the usage of __L__ in integer conversions is the GNU notation. The Linux version of these functions is based on the ''GNU libio'' library. Take a look at the ''info'' documentation of ''GNU libc (glibc-1.08)'' for a more concise description. !!BUGS All functions are fully ANSI X3.159-1989 conformant, but provide the additional flags __q__ and __a__ as well as an additional behaviour of the __L__ and __l__ flags. The latter may be considered to be a bug, as it changes the behaviour of flags defined in ANSI X3.159-1989. Some combinations of flags defined by ''ANSI C'' are not making sense in ''ANSI C'' (e.g. __%Ld__). While they may have a well-defined behaviour on Linux, this need not to be so on other architectures. Therefore it usually is better to use flags that are not defined by ''ANSI C'' at all, i.e. use __q__ instead of __L__ in combination with __diouxX__ conversions or __ll__. The usage of __q__ is not the same as on ''BSD 4.4'', as it may be used in float conversions equivalently to __L__. ----
One page links to
sscanf(3)
:
Man3s
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
