1.\" $NetBSD: getwc.3,v 1.3 2002/02/07 07:00:26 ross Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek and the American National Standards Committee X3, 8.\" on Information Processing Systems. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. All advertising materials mentioning features or use of this software 19.\" must display the following acknowledgement: 20.\" This product includes software developed by the University of 21.\" California, Berkeley and its contributors. 22.\" 4. Neither the name of the University nor the names of its contributors 23.\" may be used to endorse or promote products derived from this software 24.\" without specific prior written permission. 25.\" 26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36.\" SUCH DAMAGE. 37.\" 38.\" @(#)getc.3 8.1 (Berkeley) 6/4/93 39.\" 40.Dd October 24, 2001 41.Dt GETWC 3 42.Os 43.Sh NAME 44.Nm fgetwc , 45.Nm getwc , 46.Nm getwchar , 47.Nd get next wide-character from input stream 48.Sh LIBRARY 49.Lb libc 50.Sh SYNOPSIS 51.Fd #include \*[Lt]stdio.h\*[Gt] 52.Fd #include \*[Lt]wchar.h\*[Gt] 53.Ft wint_t 54.Fn fgetwc "FILE *stream" 55.Ft wint_t 56.Fn getwc "FILE *stream" 57.Ft wint_t 58.Fn getwchar 59.Sh DESCRIPTION 60The 61.Fn fgetwc 62function 63obtains the next input wide-character (if present) from the stream pointed at by 64.Fa stream , 65or the next character pushed back on the stream via 66.Xr ungetwc 3 . 67.Pp 68The 69.Fn getwc 70function 71acts essentially identically to 72.Fn fgetwc , 73but is a macro that expands in-line. 74.Pp 75The 76.Fn getwchar 77function 78is equivalent to 79.Fn getwc 80with the argument stdin. 81.Sh RETURN VALUES 82If successful, these routines return the next wide-character 83from the 84.Fa stream . 85If the stream is at end-of-file or a read error occurs, 86the routines return 87.Dv WEOF . 88The routines 89.Xr feof 3 90and 91.Xr ferror 3 92must be used to distinguish between end-of-file and error. 93If an error occurs, the global variable 94.Va errno 95is set to indicate the error. 96The end-of-file condition is remembered, even on a terminal, and all 97subsequent attempts to read will return 98.Dv WEOF 99until the condition is cleared with 100.Xr clearerr 3 . 101.Sh SEE ALSO 102.Xr ferror 3 , 103.Xr fopen 3 , 104.Xr fread 3 , 105.Xr putwc 3 , 106.Xr stdio 3 , 107.Xr ungetwc 3 108.Sh STANDARDS 109The 110.Fn fgetwc , 111.Fn getwc 112and 113.Fn getwchar 114functions 115conform to 116.St -isoC99 . 117