*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> fgetln (3)              
Title
Content
Arch
Section
 

FGETLN(3)

Contents


NAME    [Toc]    [Back]

     fgetln -- get a line from a stream

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <stdio.h>

     char *
     fgetln(FILE *stream, size_t *len);

DESCRIPTION    [Toc]    [Back]

     The fgetln() function returns a pointer to the next line from the stream
     referenced by stream.  This line is not a C string as it does not end
     with a terminating NUL character.	The length of the line, including the
     final newline, is stored in the memory location to which len points.
     (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.)

RETURN VALUES    [Toc]    [Back]

     Upon successful completion a pointer is returned; this pointer becomes
     invalid after the next I/O operation on stream (whether successful or
     not) or as soon as the stream is closed.  Otherwise, NULL is returned.
     The fgetln() function does not distinguish between end-of-file and error;
     the routines feof(3) and ferror(3) must be used to determine which
     occurred.	If an error occurs, the global variable errno 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 NULL until the
     condition is cleared with clearerr(3).

     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.

ERRORS    [Toc]    [Back]

     [EBADF]		The argument stream is not a stream open for reading.

     The fgetln() function may also fail and set errno for any of the errors
     specified for the routines fflush(3), malloc(3), read(2), stat(2), or
     realloc(3).

SEE ALSO    [Toc]    [Back]

      
      
     ferror(3), fgets(3), fopen(3), putc(3)

HISTORY    [Toc]    [Back]

     The fgetln() function first appeared in 4.4BSD.


FreeBSD 5.2.1			April 19, 1994			 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
puts OpenBSD output a line to a stream
puts FreeBSD output a line to a stream
fputs FreeBSD output a line to a stream
puts NetBSD output a line to a stream
fputs NetBSD output a line to a stream
fputs OpenBSD output a line to a stream
fgetws FreeBSD get a line of wide characters from a stream
fparseln OpenBSD return the next logical line from a stream
fparseln FreeBSD return the next logical line from a stream
fparseln NetBSD return the next logical line from a stream
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service