fgets, gets - get a line from a stream
Standard C Library (libc, -lc)
fgets(char * restrict str, int size, FILE * restrict stream);
The fgets() function reads at most one less than the number of characters
specified by size from the given stream and stores them in the string
str. Reading stops when a newline character is found, at end-of-file or
error. The newline, if any, is retained. In any case a `\0' character
is appended to end the string.
The gets() function is equivalent to fgets() with an infinite size and a
stream of stdin, except that the newline character (if any) is not stored
in the string. It is the caller's responsibility to ensure that the
input line, if any, is sufficiently short to fit in the string.
Upon successful completion, fgets() and gets() return a pointer to the
string. If end-of-file or an error occurs before any characters are
read, they return NULL. The fgets() and functions gets() do not distinguish
between end-of-file and error, and callers must use feof(3) and
ferror(3) to determine which occurred.
[EBADF] The given stream is not a readable stream.
The function fgets() may also fail and set errno for any of the errors
specified for the routines fflush(3), fstat(2), read(2), or malloc(3).
The function gets() may also fail and set errno for any of the errors
specified for the routine getchar(3).
feof(3), ferror(3), fgetln(3)
The functions fgets() and gets() conform to ANSI X3.159-1989
SECURITY CONSIDERATIONS [Toc] [Back]
Since it is usually impossible to ensure that the next input line is less
than some arbitrary length, and because overflowing the input buffer is
almost invariably a security violation, programs should NEVER use gets().
The gets() function exists purely to conform to ANSI X3.159-1989
BSD June 4, 1993 BSD
[ Back ]