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. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd March 3, 2004 35.Dt GETWC 3 36.Os 37.Sh NAME 38.Nm fgetwc , 39.Nm getwc , 40.Nm getwchar 41.Nd get next wide character from input stream 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In stdio.h 46.In wchar.h 47.Ft wint_t 48.Fn fgetwc "FILE *stream" 49.Ft wint_t 50.Fn getwc "FILE *stream" 51.Ft wint_t 52.Fn getwchar void 53.Sh DESCRIPTION 54The 55.Fn fgetwc 56function 57obtains the next input wide character (if present) from the stream pointed at by 58.Fa stream , 59or the next character pushed back on the stream via 60.Xr ungetwc 3 . 61.Pp 62The 63.Fn getwc 64function 65acts essentially identically to 66.Fn fgetwc . 67.Pp 68The 69.Fn getwchar 70function 71is equivalent to 72.Fn getwc 73with the argument 74.Dv stdin . 75.Sh RETURN VALUES 76If successful, these routines return the next wide character 77from the 78.Fa stream . 79If the stream is at end-of-file or a read error occurs, 80the routines return 81.Dv WEOF . 82The routines 83.Xr feof 3 84and 85.Xr ferror 3 86must be used to distinguish between end-of-file and error. 87If an error occurs, the global variable 88.Va errno 89is set to indicate the error. 90The end-of-file condition is remembered, even on a terminal, and all 91subsequent attempts to read will return 92.Dv WEOF 93until the condition is cleared with 94.Xr clearerr 3 . 95.Sh SEE ALSO 96.Xr ferror 3 , 97.Xr fopen 3 , 98.Xr fread 3 , 99.Xr getc 3 , 100.Xr putwc 3 , 101.Xr stdio 3 , 102.Xr ungetwc 3 103.Sh STANDARDS 104The 105.Fn fgetwc , 106.Fn getwc 107and 108.Fn getwchar 109functions 110conform to 111.St -isoC-99 . 112.Sh HISTORY 113A version of the 114.Fn getc 115and 116.Fn getw 117functions appeared in 118.At v1 . 119