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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)fgetln.3 8.3 (Berkeley) 4/19/94 29.\" 30.Dd July 16, 2004 31.Dt FGETWLN 3 32.Os 33.Sh NAME 34.Nm fgetwln 35.Nd get a line of wide characters from a stream 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In stdio.h 40.In wchar.h 41.Ft wchar_t * 42.Fn fgetwln "FILE * restrict stream" "size_t * restrict len" 43.Sh DESCRIPTION 44The 45.Fn fgetwln 46function 47returns a pointer to the next line from the stream referenced by 48.Fa stream . 49This line is 50.Em not 51a standard wide character string as it does not end with a terminating 52null wide character. 53The length of the line, including the final newline, 54is stored in the memory location to which 55.Fa len 56points. 57(Note, however, that if the line is the last 58in a file that does not end in a newline, 59the returned text will not contain a newline.) 60.Sh RETURN VALUES 61Upon successful completion a pointer is returned; 62this pointer becomes invalid after the next 63.Tn I/O 64operation on 65.Fa stream 66(whether successful or not) 67or as soon as the stream is closed. 68Otherwise, 69.Dv NULL 70is returned. 71The 72.Fn fgetwln 73function 74does not distinguish between end-of-file and error; the routines 75.Xr feof 3 76and 77.Xr ferror 3 78must be used 79to determine which occurred. 80If an error occurs, the global variable 81.Va errno 82is set to indicate the error. 83The end-of-file condition is remembered, even on a terminal, and all 84subsequent attempts to read will return 85.Dv NULL 86until the condition is 87cleared with 88.Xr clearerr 3 . 89.Pp 90The text to which the returned pointer points may be modified, 91provided that no changes are made beyond the returned size. 92These changes are lost as soon as the pointer becomes invalid. 93.Sh ERRORS 94.Bl -tag -width Er 95.It Bq Er EBADF 96The argument 97.Fa stream 98is not a stream open for reading. 99.El 100.Pp 101The 102.Fn fgetwln 103function 104may also fail and set 105.Va errno 106for any of the errors specified for the routines 107.Xr mbrtowc 3 , 108.Xr realloc 3 , 109or 110.Xr read 2 . 111.Sh SEE ALSO 112.Xr ferror 3 , 113.Xr fgetln 3 , 114.Xr fgetws 3 , 115.Xr fopen 3 116