lib/libc/stdio/fgetln.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. 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 .\"     @(#)fgetln.3    8.3 (Berkeley) 4/19/94
  33 .\" $FreeBSD: src/lib/libc/stdio/fgetln.3,v 1.4.2.3 2001/12/14 18:33:57 ru Exp $
  34 .\" $DragonFly: src/lib/libc/stdio/fgetln.3,v 1.2 2003/06/17 04:26:45 dillon Exp $
  35 .\"
  36 .Dd April 19, 1994
  37 .Dt FGETLN 3
  38 .Os
  39 .Sh NAME
  40 .Nm fgetln
  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 fgetln "FILE *stream" "size_t *len"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn fgetln
  51 function
  52 returns a pointer to the next line from the stream referenced by
  53 .Fa stream .
  54 This line is
  55 .Em not
  56 a C string as it does not end with a terminating
  57 .Dv NUL
  58 character.
  59 The length of the line, including the final newline,
  60 is stored in the memory location to which
  61 .Fa len
  62 points.
  63 (Note, however, that if the line is the last
  64 in a file that does not end in a newline,
  65 the returned text will not contain a newline.)
  66 .Sh RETURN VALUES
  67 Upon successful completion a pointer is returned;
  68 this pointer becomes invalid after the next
  69 .Tn I/O
  70 operation on
  71 .Fa stream
  72 (whether successful or not)
  73 or as soon as the stream is closed.
  74 Otherwise,
  75 .Dv NULL
  76 is returned.
  77 The
  78 .Fn fgetln
  79 function
  80 does not distinguish between end-of-file and error; the routines
  81 .Xr feof 3
  82 and
  83 .Xr ferror 3
  84 must be used
  85 to determine which occurred.
  86 If an error occurs, the global variable
  87 .Va errno
  88 is set to indicate the error.
  89 The end-of-file condition is remembered, even on a terminal, and all
  90 subsequent attempts to read will return
  91 .Dv NULL
  92 until the condition is
  93 cleared with
  94 .Xr clearerr 3 .
  95 .Pp
  96 The text to which the returned pointer points may be modified,
  97 provided that no changes are made beyond the returned size.
  98 These changes are lost as soon as the pointer becomes invalid.
  99 .Sh ERRORS
 100 .Bl -tag -width Er
 101 .It Bq Er EBADF
 102 The argument
 103 .Fa stream
 104 is not a stream open for reading.
 105 .El
 106 .Pp
 107 The
 108 .Fn fgetln
 109 function
 110 may also fail and set
 111 .Va errno
 112 for any of the errors specified for the routines
 113 .Xr fflush 3 ,
 114 .Xr malloc 3 ,
 115 .Xr read 2 ,
 116 .Xr stat 2 ,
 117 or
 118 .Xr realloc 3 .
 119 .Sh SEE ALSO
 120 .Xr ferror 3 ,
 121 .Xr fgets 3 ,
 122 .Xr fopen 3 ,
 123 .Xr putc 3
 124 .Sh HISTORY
 125 The
 126 .Fn fgetln
 127 function first appeared in
 128 .Bx 4.4 .