4.4BSD/usr/share/man/cat3/fgetline.0

FGETLINE(3)                 BSD Programmer's Manual                FGETLINE(3)

NNAAMMEE
     ffggeettlliinnee - get a line from a stream

SSYYNNOOPPSSIISS
     ##iinncclluuddee <<ssttddiioo..hh>>

     _c_h_a_r _*
     ffggeettlliinnee(_F_I_L_E _*_s_t_r_e_a_m, _s_i_z_e___t _*_l_e_n);

DDEESSCCRRIIPPTTIIOONN
     The ffggeettlliinnee() function returns a pointer to the next line from the
     stream referenced by _s_t_r_e_a_m. This line is _n_o_t 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 _l_e_n 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.)

RREETTUURRNN VVAALLUUEESS
     Upon successful completion a pointer is returned; this pointer becomes
     invalid after the next I/O operation on _s_t_r_e_a_m (whether successful or
     not) or as soon as the stream is closed.  Otherwise, NULL is returned.
     The ffggeettlliinnee() function does not distinguish between end-of-file and er-
     ror; the routines feof(3) and ferror(3) must be used to determine which
     occurred.  If an error occurrs, the global variable _e_r_r_n_o is set to indi-
     cate the error.  The end-of-file condition is remembered, even on a ter-
     minal, 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.

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

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

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

HHIISSTTOORRYY
     The ffggeettlliinnee() function first appeared in 4.4BSD.

4.4BSD                           June 9, 1993                                1