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: src/lib/libc/stdio/fgets.3,v 1.22 2009/02/28 06:00:58 das Exp $
  34 .\"
  35 .Dd September 9, 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 .Sh RETURN VALUES
  78 Upon successful completion,
  79 .Fn fgets
  80 and
  81 .Fn gets_s
  82 return
  83 a pointer to the string.
  84 If end-of-file occurs before any characters are read,
  85 they return
  86 .Dv NULL
  87 and the buffer contents remain unchanged.
  88 If an error occurs,
  89 they return
  90 .Dv NULL
  91 and the buffer contents are indeterminate.
  92 The
  93 .Fn fgets
  94 and
  95 .Fn gets_s
  96 functions
  97 do not distinguish between end-of-file and error, and callers must use
  98 .Xr feof 3
  99 and
 100 .Xr ferror 3
 101 to determine which occurred.
 102 .Sh ERRORS
 103 .Bl -tag -width Er
 104 .It Bq Er EBADF
 105 The given
 106 .Fa stream
 107 is not a readable stream.
 108 .El
 109 .Pp
 110 The
 111 .Fn fgets
 112 function may also fail and set
 113 .Va errno
 114 for any of the errors specified for the routines
 115 .Xr fflush 3 ,
 116 .Xr fstat 2 ,
 117 .Xr read 2 ,
 118 or
 119 .Xr malloc 3 .
 120 .Pp
 121 The
 122 .Fn gets_s
 123 function may also fail and set
 124 .Va errno
 125 for any of the errors specified for the routine
 126 .Xr getchar 3 .
 127 .Sh SEE ALSO
 128 .Xr feof 3 ,
 129 .Xr ferror 3 ,
 130 .Xr fgetln 3 ,
 131 .Xr fgetws 3 ,
 132 .Xr getline 3
 133 .Sh STANDARDS
 134 The
 135 .Fn fgets
 136 function conforms to
 137 .St -isoC-99 .
 138 .Fn gets_s
 139 conforms to
 140 .St -isoC-2011
 141 K.3.7.4.1.