1.\" Copyright (c) 1990, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" This code is derived from software contributed to Berkeley by 5.\" Chris Torek and the American National Standards Committee X3, 6.\" on Information Processing Systems. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)fgets.3 8.1 (Berkeley) 6/4/93 33.\" FreeBSD: src/lib/libc/stdio/fgets.3,v 1.16 2002/05/31 05:01:17 archie Exp 34.\" $FreeBSD: head/lib/libc/stdio/fgetws.3 165903 2007-01-09 00:28:16Z imp $ 35.\" 36.Dd August 6, 2002 37.Dt FGETWS 3 38.Os 39.Sh NAME 40.Nm fgetws 41.Nd get a line of wide characters from a stream 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In stdio.h 46.In wchar.h 47.Ft "wchar_t *" 48.Fn fgetws "wchar_t * restrict ws" "int n" "FILE * restrict fp" 49.Sh DESCRIPTION 50The 51.Fn fgetws 52function 53reads at most one less than the number of characters specified by 54.Fa n 55from the given 56.Fa fp 57and stores them in the wide character string 58.Fa ws . 59Reading stops when a newline character is found, 60at end-of-file or error. 61The newline, if any, is retained. 62If any characters are read and there is no error, a 63.Ql \e0 64character is appended to end the string. 65.Sh RETURN VALUES 66Upon successful completion, 67.Fn fgetws 68returns 69.Fa ws . 70If end-of-file occurs before any characters are read, 71.Fn fgetws 72returns 73.Dv NULL 74and the buffer contents remain unchanged. 75If an error occurs, 76.Fn fgetws 77returns 78.Dv NULL 79and the buffer contents are indeterminate. 80The 81.Fn fgetws 82function 83does not distinguish between end-of-file and error, and callers must use 84.Xr feof 3 85and 86.Xr ferror 3 87to determine which occurred. 88.Sh ERRORS 89The 90.Fn fgetws 91function will fail if: 92.Bl -tag -width Er 93.It Bq Er EBADF 94The given 95.Fa fp 96argument is not a readable stream. 97.It Bq Er EILSEQ 98The data obtained from the input stream does not form a valid 99multibyte character. 100.El 101.Pp 102The function 103.Fn fgetws 104may also fail and set 105.Va errno 106for any of the errors specified for the routines 107.Xr fflush 3 , 108.Xr fstat 2 , 109.Xr read 2 , 110or 111.Xr malloc 3 . 112.Sh SEE ALSO 113.Xr feof 3 , 114.Xr ferror 3 , 115.Xr fgets 3 116.Sh STANDARDS 117The 118.Fn fgetws 119function 120conforms to 121.St -p1003.1-2001 . 122