Seth Woolley's Man Viewer

Manual for gets - man 3 gets

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

GETS(3)                    Linux Programmer's Manual                   GETS(3)



NAME
       fgetc,  fgets,  getc,  getchar,  gets(3,n), ungetc - input of characters and
       strings

SYNOPSIS
       #include <stdio.h>

       int fgetc(FILE *stream);
       char *fgets(char *s, int size, FILE *stream);
       int getc(FILE *stream);
       int getchar(void);
       char *gets(3,n)(char *s);
       int ungetc(int c, FILE *stream);

DESCRIPTION
       fgetc() reads the next character from  stream  and  returns  it  as  an
       unsigned char cast to an int, or EOF on end of file(1,n) or error.

       getc()  is equivalent to fgetc() except that it may be implemented as a
       macro which evaluates stream more than once.

       getchar() is equivalent to getc(stdin).

       gets(3,n)() reads a line from stdin into the buffer pointed to  by  s  until
       either  a  terminating newline or EOF, which it replaces with '\0'.  No
       check for buffer overrun is performed (see BUGS below).

       fgets() reads in(1,8) at most one less(1,3) than size characters from stream  and
       stores  them  into  the buffer pointed to by s.  Reading stops after an
       EOF or a newline.  If a newline is read(2,n,1 builtins), it is stored into the  buffer.
       A '\0' is stored after the last character in(1,8) the buffer.

       ungetc()  pushes  c  back to stream, cast to unsigned char, where it is
       available for subsequent read(2,n,1 builtins) operations.   Pushed  -  back  characters
       will be returned in(1,8) reverse order; only one pushback is guaranteed.

       Calls  to the functions described here can be mixed with each other and
       with calls to other input functions from the stdio library for the same
       input stream.

       For non-locking counterparts, see unlocked_stdio(3).

RETURN VALUE
       fgetc(),  getc() and getchar() return the character read(2,n,1 builtins) as an unsigned
       char cast to an int or EOF on end of file(1,n) or error.

       gets(3,n)() and fgets() return s on success, and NULL on error(8,n) or  when  end
       of file(1,n) occurs while no characters have been read.

       ungetc() returns c on success, or EOF on error.

CONFORMING TO
       ANSI - C, POSIX.1.  LSB deprecates gets(3,n)().

BUGS
       Never use gets(3,n)().  Because it is impossible to tell without knowing the
       data in(1,8) advance how many  characters  gets(3,n)()  will  read(2,n,1 builtins),  and  because
       gets(3,n)() will continue to store characters past the end of the buffer, it
       is extremely dangerous to use.  It has  been  used  to  break  computer
       security.  Use fgets() instead.

       It  is  not  advisable  to  mix calls to input functions from the stdio
       library with low - level calls to read(2,n,1 builtins)() for the file(1,n) descriptor  asso-
       ciated  with  the  input stream; the results will be undefined and very
       probably not what you want.

SEE ALSO
       read(2,n,1 builtins)(2), write(1,2)(2), ferror(3), fopen(3),  fread(3),  fseek(3),  puts(3,n)(3),
       scanf(3), unlocked_stdio(3)



GNU                               1993-04-04                           GETS(3)

References for this manual (incoming links)