.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\" %sccs.include.redist.man%
.\" @(#)fgetln.3 8.1 (Berkeley) %G%
.Nd get a line from a stream
.Fn fgetline "FILE *stream" "size_t *len"
returns a pointer to the next line from the stream referenced by
a C string as it does not end with a terminating
The length of the line, including the final newline,
is stored in the memory location to which
(Note, however, that if the line is the last
in a file that does not end in a newline,
the returned text will not contain a newline.)
Upon successful completion a pointer is returned;
this pointer becomes invalid after the next
(whether successful or not)
or as soon as the stream is closed.
does not distinguish between end-of-file and error; the routines
to determine which occurred.
If an error occurrs, the global variable
is set to indicate the error.
The end-of-file condition is remembered, even on a terminal, and all
subsequent attempts to read will return
The text to which the returned pointer points may be modified,
provided that no changes are made beyond the returned size.
These changes are lost as soon as the pointer becomes invalid.
is not a stream open for reading.
for any of the errors specified for the routines
function first appeared in 4.4BSD.