scanf(3) — Linux manual page


scanf(3)                Library Functions Manual                scanf(3)

NAME         top

       scanf, fscanf, vscanf, vfscanf - input FILE format conversion

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <stdio.h>

       int scanf(const char *restrict format, ...);
       int fscanf(FILE *restrict stream,
                  const char *restrict format, ...);

       #include <stdarg.h>

       int vscanf(const char *restrict format, va_list ap);
       int vfscanf(FILE *restrict stream,
                  const char *restrict format, va_list ap);

   Feature Test Macro Requirements for glibc (see

       vscanf(), vfscanf():
           _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L

DESCRIPTION         top

       The scanf() family of functions scans input like sscanf(3), but
       read from a FILE.  It is very difficult to use these functions
       correctly, and it is preferable to read entire lines with
       fgets(3) or getline(3) and parse them later with sscanf(3) or
       more specialized functions such as strtol(3).

       The scanf() function reads input from the standard input stream
       stdin and fscanf() reads input from the stream pointer stream.

       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 is
       analogous to vprintf(3) and reads from the standard input.

RETURN VALUE         top

       On success, these functions return the number of input items
       successfully matched and assigned; this can be fewer than
       provided for, or even zero, in the event of an early matching

       The value EOF is returned if the end of input is reached before
       either the first successful conversion or a matching failure
       occurs.  EOF is also returned if a read error occurs, in which
       case the error indicator for the stream (see ferror(3)) is set,
       and errno is set to indicate the error.

ERRORS         top

       EAGAIN The file descriptor underlying stream is marked
              nonblocking, and the read operation would block.

       EBADF  The file descriptor underlying stream is invalid, or not
              open for reading.

       EILSEQ Input byte sequence does not form a valid character.

       EINTR  The read operation was interrupted by a signal; see

       EINVAL Not enough arguments; or format is NULL.

       ENOMEM Out of memory.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       │ Interface                    Attribute     Value          │
       │ scanf(), fscanf(), vscanf(), │ Thread safety │ MT-Safe locale │
       │ vfscanf()                    │               │                │

STANDARDS         top

       C11, POSIX.1-2008.

HISTORY         top

       C99, POSIX.1-2001.

SEE ALSO         top

       fgets(3), getline(3), sscanf(3)

Linux man-pages (unreleased)     (date)                         scanf(3)

Pages that refer to this page: curs_scanw(3x)fgetc(3)FILE(3type)getline(3)gets(3)intmax_t(3type)intN_t(3type)intptr_t(3type)lber-decode(3)pmfstring(3)printf(3)ptrdiff_t(3type)puts(3)size_t(3type)stdarg(3)stdio(3)strptime(3)void(3type)proc(5)locale(7)system_data_types(7)