lib/libc/stdio/fgets.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)fgets.3     8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd June 4, 1993
  40 .Dt FGETS 3
  41 .Os
  42 .Sh NAME
  43 .Nm fgets ,
  44 .Nm gets
  45 .Nd get a line from a stream
  46 .Sh SYNOPSIS
  47 .Fd #include <stdio.h>
  48 .Ft char *
  49 .Fn fgets "char *str" "int size" "FILE *stream"
  50 .Ft char *
  51 .Fn gets "char *str"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn fgets
  55 function
  56 reads at most one less than the number of characters specified by
  57 .Fa size
  58 from the given
  59 .Fa stream
  60 and stores them in the string
  61 .Fa str .
  62 Reading stops when a newline character is found,
  63 at end-of-file or error.
  64 The newline, if any, is retained.
  65 If any characters are read and there is no error, a
  66 .Ql \e0
  67 character is appended to end the string.
  68 .Pp
  69 The
  70 .Fn gets
  71 function
  72 is equivalent to
  73 .Fn fgets
  74 with an infinite
  75 .Fa size
  76 and a
  77 .Fa stream
  78 of
  79 .Em stdin ,
  80 except that the newline character (if any) is not stored in the string.
  81 It is the caller's responsibility to ensure that the input line,
  82 if any, is sufficiently short to fit in the string.
  83 .Sh RETURN VALUES
  84 .Pp
  85 Upon successful completion,
  86 .Fn fgets
  87 and
  88 .Fn gets
  89 return
  90 a pointer to the string.
  91 If end-of-file occurs before any characters are read,
  92 they return
  93 .Dv NULL
  94 and the buffer contents is unchanged.
  95 If an error occurs,
  96 they return
  97 .Dv NULL
  98 and the buffer contents is indeterminate.
  99 The
 100 .Fn fgets
 101 and
 102 .Fn gets
 103 functions
 104 do not distinguish between end-of-file and error, and callers must use
 105 .Xr feof 3
 106 and
 107 .Xr ferror 3
 108 to determine which occurred.
 109 .Sh ERRORS
 110 .Bl -tag -width [EBADF]
 111 .It Bq Er EBADF
 112 The given
 113 .Fa stream
 114 is not a readable stream.
 115 .El
 116 .Pp
 117 The function
 118 .Fn fgets
 119 may also fail and set
 120 .Va errno
 121 for any of the errors specified for the routines
 122 .Xr fflush 3 ,
 123 .Xr fstat 2 ,
 124 .Xr read 2 ,
 125 or
 126 .Xr malloc 3 .
 127 .Pp
 128 The function
 129 .Fn gets
 130 may also fail and set
 131 .Va errno
 132 for any of the errors specified for the routine
 133 .Xr getchar 3 .
 134 .Sh SEE ALSO
 135 .Xr feof 3 ,
 136 .Xr ferror 3 ,
 137 .Xr fgetln 3
 138 .Sh STANDARDS
 139 The functions
 140 .Fn fgets
 141 and
 142 .Fn gets
 143 conform to
 144 .St -ansiC .
 145 .Sh BUGS
 146 Since it is usually impossible to ensure that the next input line
 147 is less than some arbitrary length, and because overflowing the
 148 input buffer is almost invariably a security violation, programs
 149 should
 150 .Em NEVER
 151 use
 152 .Fn gets .
 153 The
 154 .Fn gets
 155 function
 156 exists purely to conform to
 157 .St -ansiC .