Rewrote substantial parts of the page, and relicensed under GPL.

[thirdparty/man-pages.git] / man3 / scanf.3

.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)scanf.3	6.14 (Berkeley) 1/8/93
.\"
.\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
.\" modified to resemble the GNU libio setup used in the Linux libc 
.\" used in versions 4.x (x>4) and 5   Helmut.Geyer@iwr.uni-heidelberg.de
.\" Modified, aeb, 970121
.\" 2005-07-14, mtk, added description of %n$ form; various text 
.\"	incorporated from the GNU C library documentation ((C) The 
.\"	Free Software Foundation); other parts substantially rewritten.
.\"
.TH SCANF 3  1995-11-01 "LINUX MANPAGE" "Linux Programmer's Manual"
.SH NAME
scanf, fscanf, sscanf, vscanf, vsscanf, vfscanf \- input format conversion
.SH SYNOPSIS
.nf
.B #include <stdio.h>
.na
.BI "int scanf(const char *" format ", ..." );
.br
.BI "int fscanf(FILE *" stream ", const char *" format ", ..." );
.br
.BI "int sscanf(const char *" str ", const char *" format ", ..." );
.sp
.B #include <stdarg.h>
.BI "int vscanf(const char *" format ", va_list " ap );
.br
.BI "int vsscanf(const char *" str ", const char *" format ", va_list " ap );
.br
.BI "int vfscanf(FILE *" stream ", const char *" format ", va_list " ap );
.ad
.SH DESCRIPTION
The
.BR scanf ()
family of functions scans input according to
.I format
as described below.  This format may contain
.IR "conversion specifications" ;
the results from such conversions, if any,
are stored in the locations pointed to by the
.I pointer 
arguments that follow
.IR format .
Each 
.I pointer
argument must be of a type that is appropriate for the value returned 
by the corresponding conversion specification.

If the number of conversion specifications in
.I format
exceeds the number of
.I pointer
arguments, the results are undefined.
If the number of
.I pointer
arguments exceeds the number of conversion specifications, then the excess
.I pointer
arguments are evaluated, but are otherwise ignored.

The
.BR scanf ()
function reads input from the standard input stream
.IR stdin ,
.BR fscanf ()
reads input from the stream pointer
.IR stream ,
and
.BR sscanf ()
reads its input from the character string pointed to by
.IR str .
.PP
The
.BR vfscanf ()
function is analogous to
.BR vfprintf (3)
and reads input from the stream pointer
.I stream
using a variable argument list of pointers (see
.BR stdarg (3).
The
.BR vscanf ()
function scans a variable argument list from the standard input and the
.BR vsscanf ()
function scans it from a string; these are analogous to the
.BR vprintf ()
and
.BR vsprintf ()
functions respectively.
.PP
The
.I format
string consists of a sequence of 
.IR directives 
which describe how to process the sequence of input characters.
If processing of a directive fails, no further input is read, and
.BR scanf ()
returns.
A "failure" can be either of the following:
.IR "input failure" ,
meaning that input characters were unavailable, or
.IR "matching failure" ,
meaning that the input was inappropriate (see below).

A directive is one of the following:
.TP
\(bu
A sequence of white-space characters (space, tab, newline, etc; see 
.BR isspace (3)).
This directive matches any amount of white space,
including none, in the input.
.TP
\(bu
An ordinary character (i.e., one other than white space or '%').
This character must exactly match the next character of input.
.TP
\(bu
A conversion specification, which commences with a '%' (percent) character.
A sequence of characters from the input is converted according to 
this specification, and the result is placed in the corresponding
.I pointer
argument.
If the next item of input does not match the the conversion specification,
the conversion fails \(em this is a
.IR "matching failure" .
.PP
Each
.I conversion specification 
in
.I format 
begins with either the character '%' or the character sequence 
"\fB%\fP\fIn\fP\fB$\fP"
(see below for the distinction; see below) followed by:
.TP
\(bu
An optional '*' assignment-suppression character:
.BR scanf ()
reads input as directed by the conversion specification,
but discards the input.
No corresponding
.I pointer
argument is required, and this specification is not
included in the count of successful assignments returned by
.BR scanf ().
.TP
\(bu
An optional 'a' character.
This is used with string conversions, and relieves the caller of the 
need to allocate a corresponding buffer to hold the input: instead,
.BR scanf ()
allocates a buffer of sufficient size, 
and assigns the address of this buffer to the corresponding
.I pointer
argument, which should be a pointer to a
.I "char *"
variable (this variable does not need to be initialised before the call).
The caller should subsequently
.BR free (3)
this buffer when it is no longer required.
This is a GNU extension;
C99 employs the 'a' character as a conversion specifier (and
it can also be used as such in the GNU implementation).
.TP
\(bu
An optional decimal integer which specifies the
.IR "maximum field width" .
Reading of characters stops either when this maximum is reached or 
when a non-matching character is found, whichever happens first. 
Most conversions discard initial whitespace characters (the exceptions 
are noted below), 
and these discarded characters don't count towards the maximum field width.
String input conversions store a null terminator ('\\0') 
to mark the end of the input; 
the maximum field width does not include this terminator.
.TP
\(bu
An optional 
.IR "type modifier character" . 
For example, the
.B l
type modifier is used with integer conversions such as 
.I %d 
to specify that the corresponding
.I pointer
argument refers to a 
.I "long int"
rather than a pointer to an 
.IR int .
.TP
\(bu
A 
.I "conversion specifier"
that specifies the type of input conversion to be performed.
.PP    
The conversion specifications in
.I format
are of two forms, either beginning with '%' or beginning with 
"\fB%\fP\fIn\fP\fB$\fP".
The two forms should not be mixed in the same 
.I format
string, except that a string containing 
"\fB%\fP\fIn\fP\fB$\fP"
specifications can include
.I %%
and 
.IR %* .
If
.I format
contains '%'
specifications then these correspond in order with successive
.I pointer
arguments.
In the
"\fB%\fP\fIn\fP\fB$\fP"
form (which is specified in SUSv3, but not C99),
.I n
is a decimal integer that specifies that the converted input should 
be placed in the location referred to by the
.IR n -th
.I pointer
argument following
.IR format .
.SH CONVERSIONS
The following
.IR "type modifier characters" 
can appear in a conversion specification:
.TP
.B h
Indicates that the conversion will be one of
.B diouxX
or
.B n
and the next pointer is a pointer to a
.I short int
or
.I unsigned short int
(rather than
.IR int ).
.TP
.B hh
As for
.BR h ,
but the next pointer is a pointer to a
.I signed char
or
.IR "unsigned char" .
.TP
.B j
As for
.BR h ,
but the next pointer is a pointer to a
.I intmax_t
or
.IR uintmax_t .
This modifier was introduced in C99.
.TP
.B l
Indicates either that the conversion will be one of
.B diouxX
or
.B n
and the next pointer is a pointer to a
.I long int
or
.I unsigned long int
(rather than
.IR int ),
or that the conversion will be one of
.B efg
and the next pointer is a pointer to
.I double
(rather than
.IR float ).
Specifying two 
.B l
characters is equivalent to
.BR L .
If used with
.I %c 
or 
.I %s 
the corresponding parameter is considered 
as a pointer to a wide character or wide character string respectively. 
.\" This use of l was introduced in Amendment 1 to ISO C90.
.TP
.B L
Indicates that the conversion will be either
.B efg
and the next pointer is a pointer to
.IR "long double" 
or the conversion will be 
.B dioux
and the next pointer is a pointer to
.IR "long long" .
.\" MTK, Jul 05: The following is no longer true for modern 
.\" ANSI C (i.e., C99):
.\" (Note that long long is not an 
.\" ANSI C 
.\" type. Any program using this will not be portable to all
.\" architectures).
.TP
.B q
equivalent to 
.BR L . 
This specifier does not exist in ANSI C.
.TP
.B t
As for
.BR h ,
but the next pointer is a pointer to a
.IR ptrdiff_t .
This modifier was introduced in C99.
.TP
.B z
As for
.BR h ,
but the next pointer is a pointer to a
.IR size_t .
This modifier was introduced in C99.
.PP
The following 
.I "conversion specifiers"
are available:
.TP
.B %
Matches a literal '%'.  That is, 
.I %\&% 
in the format string matches a
single input '%' character.  No conversion is done, and assignment does not
occur.
.TP
.B d
Matches an optionally signed decimal integer;
the next pointer must be a pointer to
.IR int .
.TP
.B D
Equivalent to
.IR ld ;
this exists only for backwards compatibility.
(Note: thus only in libc4. In libc5 and glibc the
.I %D 
is silently ignored, causing old programs to fail mysteriously.)
.TP
.B i
Matches an optionally signed integer; the next pointer must be a pointer to
.IR int .
The integer is read in base 16 if it begins with 
.I 0x
or 
.IR 0X , 
in base 8 if it begins with 
.IR 0 , 
and in base 10 otherwise.
Only characters that correspond to the base are used.
.TP
.B o
Matches an unsigned octal integer; the next pointer must be a pointer to
.IR "unsigned int" .
.TP
.B u
Matches an unsigned decimal integer; the next pointer must be a
pointer to
.IR "unsigned int" .
.TP
.B x
Matches an unsigned hexadecimal integer; the next pointer must
be a pointer to
.IR "unsigned int" .
.TP
.B X
Equivalent to
.BR x .
.TP
.B f
Matches an optionally signed floating-point number; the next pointer must
be a pointer to
.IR float .
.TP
.B e
Equivalent to
.BR f .
.TP
.B g
Equivalent to
.BR f .
.TP
.B E
Equivalent to
.BR f .
.TP
.B a
(C99) Equivalent to
.BR f .
.TP
.B s
Matches a sequence of non-white-space characters;
the next pointer must be a pointer to character array that is 
long enough to hold the input sequence and the terminating null 
character ('\\0'), which is added automatically.
The input string stops at white space or at the maximum field
width, whichever occurs first.
.TP
.B c
Matches a sequence of characters whose length is specified by the
.I maximum field width
(default 1); the next pointer must be a pointer to
.IR char ,
and there must be enough room for all the characters (no terminating
null character
is added).  The usual skip of leading white space is suppressed.  To skip
white space first, use an explicit space in the format.
.TP
.B \&[
Matches a nonempty sequence of characters from the specified set of
accepted characters; the next pointer must be a pointer to
.IR char ,
and there must be enough room for all the characters in the string, plus a
terminating null 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
.B [
character and a close bracket
.B ]
character.  The set
.I excludes
those characters if the first character after the open bracket is a
circumflex
.RR ( ^ ).
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
.B \-
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, 
.B [^]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.
.TP
.B p
Matches a pointer value (as printed by 
.I %p
in
.BR printf (3);
the next pointer must be a pointer to a pointer to
.IR void .
.TP
.B 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
.IR int .
This is
.I not
a conversion, although it can be suppressed with the
.B *
assignment-suppression character.
The C standard says: "Execution of a 
.I %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
.I %n 
conversions on the return value.

.PP
.SH "RETURN VALUE"
These functions return the number of input items 
successfully matched and assigned, 
which can be fewer than provided for, 
or even zero in the event of an early matching failure.

The value
.B EOF
is returned if the end of input is reached before the first 
successful conversion or matching failure occurs.
.B EOF
is also returned if a read error occurs, 
in which case the error indicator for the stream (see
.BR ferror (3))
is set, and
.I errno
is set indicate the error.
.SH "SEE ALSO"
.BR getc (3),
.BR printf (3),
.BR strtod (3),
.BR strtol (3),
.BR strtoul (3)
.SH "CONFORMING TO"
The functions
.BR fscanf (),
.BR scanf (),
and
.BR sscanf ()
conform to ANSI X3.159-1989 (``ANSI C'').
.PP
The 
.B q
specifier is the 
.I 4.4BSD
notation for 
.IR "long long" ,
while
.B ll
or the usage of
.B L
in integer conversions is the GNU notation.
.PP
The Linux version of these functions is based on the 
.I GNU 
.I libio
library. Take a look at the 
.I info
documentation of 
.I GNU
.I libc (glibc-1.08)
for a more concise description. 
.SH BUGS
All functions are fully ANSI X3.159-1989 conformant, but provide the 
additional specifiers 
.B q
and
.B a
as well as an additional behaviour of the
.B L
and 
.B l 
specifiers. The latter may be considered to be a bug, as it changes the
behaviour of specifiers defined in ANSI X3.159-1989.
.PP
Some combinations of the type modifiers and conversion 
specifiers defined by ANSI C do not make sense 
(e.g. 
.BR "%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
modifiers that are not defined by ANSI C at all, i.e. use 
.B q
instead of 
.B L
in combination with 
.B diouxX
conversions or 
.BR ll .
.PP
The usage of
.B q
is not the same as on
.IR "4.4BSD" ,
as it may be used in float conversions equivalently to 
.BR L .