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.\" 4. 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.\" @(#)getc.3 8.1 (Berkeley) 6/4/93 35.\" $FreeBSD: src/lib/libc/stdio/getwc.3,v 1.8 2007/01/09 00:28:06 imp Exp $ 36.\" $DragonFly: src/lib/libc/stdio/getwc.3,v 1.1 2005/07/25 00:37:41 joerg Exp $ 37.\" 38.Dd March 3, 2004 39.Dt GETWC 3 40.Os 41.Sh NAME 42.Nm fgetwc , 43.Nm getwc , 44.Nm getwchar 45.Nd get next wide character from input stream 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.In stdio.h 50.In wchar.h 51.Ft wint_t 52.Fn fgetwc "FILE *stream" 53.Ft wint_t 54.Fn getwc "FILE *stream" 55.Ft wint_t 56.Fn getwchar void 57.Sh DESCRIPTION 58The 59.Fn fgetwc 60function 61obtains the next input wide character (if present) from the stream pointed at by 62.Fa stream , 63or the next character pushed back on the stream via 64.Xr ungetwc 3 . 65.Pp 66The 67.Fn getwc 68function 69acts essentially identically to 70.Fn fgetwc . 71.Pp 72The 73.Fn getwchar 74function 75is equivalent to 76.Fn getwc 77with the argument 78.Dv stdin . 79.Sh RETURN VALUES 80If successful, these routines return the next wide character 81from the 82.Fa stream . 83If the stream is at end-of-file or a read error occurs, 84the routines return 85.Dv WEOF . 86The routines 87.Xr feof 3 88and 89.Xr ferror 3 90must be used to distinguish between end-of-file and error. 91If an error occurs, the global variable 92.Va errno 93is set to indicate the error. 94The end-of-file condition is remembered, even on a terminal, and all 95subsequent attempts to read will return 96.Dv WEOF 97until the condition is cleared with 98.Xr clearerr 3 . 99.Sh SEE ALSO 100.Xr ferror 3 , 101.Xr fopen 3 , 102.Xr fread 3 , 103.Xr getc 3 , 104.Xr putwc 3 , 105.Xr stdio 3 , 106.Xr ungetwc 3 107.Sh STANDARDS 108The 109.Fn fgetwc , 110.Fn getwc 111and 112.Fn getwchar 113functions 114conform to 115.St -isoC-99 . 116