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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fgets.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd September 1, 2019
  36 .Dt FGETS 3
  37 .Os
  38 .Sh NAME
  39 .Nm fgets ,
  40 .Nm gets_s
  41 .Nd get a line from a stream
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdio.h
  46 .Ft char *
  47 .Fn fgets "char * restrict str" "int size" "FILE * restrict stream"
  48 .Ft char *
  49 .Fn gets_s "char *str" "rsize_t size"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn fgets
  53 function
  54 reads at most one less than the number of characters specified by
  55 .Fa size
  56 from the given
  57 .Fa stream
  58 and stores them in the string
  59 .Fa str .
  60 Reading stops when a newline character is found,
  61 at end-of-file or error.
  62 The newline, if any, is retained.
  63 If any characters are read and there is no error, a
  64 .Ql \e0
  65 character is appended to end the string.
  66 .Pp
  67 The
  68 .Fn gets_s
  69 function
  70 is equivalent to
  71 .Fn fgets
  72 with a
  73 .Fa stream
  74 of
  75 .Dv stdin ,
  76 except that the newline character (if any) is not stored in the string.
  77 .Pp
  78 The
  79 .Fn gets
  80 function
  81 was unsafe and is no longer available.
  82 .Sh RETURN VALUES
  83 Upon successful completion,
  84 .Fn fgets
  85 and
  86 .Fn gets_s
  87 return
  88 a pointer to the string.
  89 If end-of-file occurs before any characters are read,
  90 they return
  91 .Dv NULL
  92 and the buffer contents remain unchanged.
  93 If an error occurs,
  94 they return
  95 .Dv NULL
  96 and the buffer contents are indeterminate.
  97 The
  98 .Fn fgets
  99 and
 100 .Fn gets_s
 101 functions
 102 do not distinguish between end-of-file and error, and callers must use
 103 .Xr feof 3
 104 and
 105 .Xr ferror 3
 106 to determine which occurred.
 107 .Sh ERRORS
 108 .Bl -tag -width Er
 109 .It Bq Er EBADF
 110 The given
 111 .Fa stream
 112 is not a readable stream.
 113 .El
 114 .Pp
 115 The function
 116 .Fn fgets
 117 may also fail and set
 118 .Va errno
 119 for any of the errors specified for the routines
 120 .Xr fflush 3 ,
 121 .Xr fstat 2 ,
 122 .Xr read 2 ,
 123 or
 124 .Xr malloc 3 .
 125 .Pp
 126 The function
 127 .Fn gets_s
 128 may also fail and set
 129 .Va errno
 130 for any of the errors specified for the routine
 131 .Xr getchar 3 .
 132 .Sh SEE ALSO
 133 .Xr feof 3 ,
 134 .Xr ferror 3 ,
 135 .Xr fgetln 3 ,
 136 .Xr fgetws 3 ,
 137 .Xr getline 3
 138 .Sh STANDARDS
 139 The
 140 .Fn fgets
 141 function conforms to
 142 .St -isoC-99 .
 143 .Fn gets_s
 144 conforms to
 145 .St -isoC-2011
 146 K.3.7.4.1.
 147 .Fn gets
 148 has been removed from
 149 .St -isoC-2011 .