158f0484fSRodney W. Grimes.\" Copyright (c) 1990, 1991, 1993 258f0484fSRodney W. Grimes.\" The Regents of the University of California. All rights reserved. 358f0484fSRodney W. Grimes.\" 458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without 558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions 658f0484fSRodney W. Grimes.\" are met: 758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright 858f0484fSRodney W. Grimes.\" notice, this list of conditions and the following disclaimer. 958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright 1058f0484fSRodney W. Grimes.\" notice, this list of conditions and the following disclaimer in the 1158f0484fSRodney W. Grimes.\" documentation and/or other materials provided with the distribution. 1258f0484fSRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software 1358f0484fSRodney W. Grimes.\" must display the following acknowledgement: 1458f0484fSRodney W. Grimes.\" This product includes software developed by the University of 1558f0484fSRodney W. Grimes.\" California, Berkeley and its contributors. 1658f0484fSRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors 1758f0484fSRodney W. Grimes.\" may be used to endorse or promote products derived from this software 1858f0484fSRodney W. Grimes.\" without specific prior written permission. 1958f0484fSRodney W. Grimes.\" 2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3058f0484fSRodney W. Grimes.\" SUCH DAMAGE. 3158f0484fSRodney W. Grimes.\" 3258f0484fSRodney W. Grimes.\" @(#)fgetln.3 8.3 (Berkeley) 4/19/94 3358f0484fSRodney W. Grimes.\" 3458f0484fSRodney W. Grimes.Dd April 19, 1994 3558f0484fSRodney W. Grimes.Dt FGETLN 3 3658f0484fSRodney W. Grimes.Os 3758f0484fSRodney W. Grimes.Sh NAME 3858f0484fSRodney W. Grimes.Nm fgetln 3958f0484fSRodney W. Grimes.Nd get a line from a stream 4058f0484fSRodney W. Grimes.Sh SYNOPSIS 4158f0484fSRodney W. Grimes.Fd #include <stdio.h> 4258f0484fSRodney W. Grimes.Ft char * 4358f0484fSRodney W. Grimes.Fn fgetln "FILE *stream" "size_t *len" 4458f0484fSRodney W. Grimes.Sh DESCRIPTION 4558f0484fSRodney W. GrimesThe 4658f0484fSRodney W. Grimes.Fn fgetln 4758f0484fSRodney W. Grimesfunction 4858f0484fSRodney W. Grimesreturns a pointer to the next line from the stream referenced by 4958f0484fSRodney W. Grimes.Fa stream . 5058f0484fSRodney W. GrimesThis line is 5158f0484fSRodney W. Grimes.Em not 5258f0484fSRodney W. Grimesa C string as it does not end with a terminating 5358f0484fSRodney W. Grimes.Dv NUL 5458f0484fSRodney W. Grimescharacter. 5558f0484fSRodney W. GrimesThe length of the line, including the final newline, 5658f0484fSRodney W. Grimesis stored in the memory location to which 5758f0484fSRodney W. Grimes.Fa len 5858f0484fSRodney W. Grimespoints. 5958f0484fSRodney W. Grimes(Note, however, that if the line is the last 6058f0484fSRodney W. Grimesin a file that does not end in a newline, 6158f0484fSRodney W. Grimesthe returned text will not contain a newline.) 6258f0484fSRodney W. Grimes.Sh RETURN VALUES 6358f0484fSRodney W. GrimesUpon successful completion a pointer is returned; 6458f0484fSRodney W. Grimesthis pointer becomes invalid after the next 6558f0484fSRodney W. Grimes.Tn I/O 6658f0484fSRodney W. Grimesoperation on 6758f0484fSRodney W. Grimes.Fa stream 6858f0484fSRodney W. Grimes(whether successful or not) 6958f0484fSRodney W. Grimesor as soon as the stream is closed. 7058f0484fSRodney W. GrimesOtherwise, 7158f0484fSRodney W. Grimes.Dv NULL 7258f0484fSRodney W. Grimesis returned. 7358f0484fSRodney W. GrimesThe 7458f0484fSRodney W. Grimes.Fn fgetln 7558f0484fSRodney W. Grimesfunction 7658f0484fSRodney W. Grimesdoes not distinguish between end-of-file and error; the routines 7758f0484fSRodney W. Grimes.Xr feof 3 7858f0484fSRodney W. Grimesand 7958f0484fSRodney W. Grimes.Xr ferror 3 8058f0484fSRodney W. Grimesmust be used 8158f0484fSRodney W. Grimesto determine which occurred. 8258f0484fSRodney W. GrimesIf an error occurs, the global variable 8358f0484fSRodney W. Grimes.Va errno 8458f0484fSRodney W. Grimesis set to indicate the error. 8558f0484fSRodney W. GrimesThe end-of-file condition is remembered, even on a terminal, and all 8658f0484fSRodney W. Grimessubsequent attempts to read will return 8758f0484fSRodney W. Grimes.Dv NULL 8858f0484fSRodney W. Grimesuntil the condition is 8958f0484fSRodney W. Grimescleared with 9058f0484fSRodney W. Grimes.Xr clearerr 3 . 9158f0484fSRodney W. Grimes.Pp 9258f0484fSRodney W. GrimesThe text to which the returned pointer points may be modified, 9358f0484fSRodney W. Grimesprovided that no changes are made beyond the returned size. 9458f0484fSRodney W. GrimesThese changes are lost as soon as the pointer becomes invalid. 9558f0484fSRodney W. Grimes.Sh ERRORS 9658f0484fSRodney W. Grimes.Bl -tag -width [EBADF] 9758f0484fSRodney W. Grimes.It Bq Er EBADF 9858f0484fSRodney W. GrimesThe argument 9958f0484fSRodney W. Grimes.Fa stream 10058f0484fSRodney W. Grimesis not a stream open for reading. 10158f0484fSRodney W. Grimes.El 10258f0484fSRodney W. Grimes.Pp 10358f0484fSRodney W. GrimesThe 10458f0484fSRodney W. Grimes.Fn fgetln 10558f0484fSRodney W. Grimesfunction 10658f0484fSRodney W. Grimesmay also fail and set 10758f0484fSRodney W. Grimes.Va errno 10858f0484fSRodney W. Grimesfor any of the errors specified for the routines 10958f0484fSRodney W. Grimes.Xr fflush 3 , 11058f0484fSRodney W. Grimes.Xr malloc 3 , 11158f0484fSRodney W. Grimes.Xr read 2 , 11258f0484fSRodney W. Grimes.Xr stat 2 , 11358f0484fSRodney W. Grimesor 11458f0484fSRodney W. Grimes.Xr realloc 3 . 11558f0484fSRodney W. Grimes.Sh SEE ALSO 11658f0484fSRodney W. Grimes.Xr ferror 3 , 11758f0484fSRodney W. Grimes.Xr fgets 3 , 11858f0484fSRodney W. Grimes.Xr fopen 3 , 11958f0484fSRodney W. Grimes.Xr putc 3 12058f0484fSRodney W. Grimes.Sh HISTORY 12158f0484fSRodney W. GrimesThe 12258f0484fSRodney W. Grimes.Fn fgetln 1237bdf80e5SMike Pritchardfunction first appeared in 1247bdf80e5SMike Pritchard.Bx 4.4 . 125