1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
8 .\" References consulted:
9 .\" GNU glibc-2 source code and manual
10 .\" Dinkumware C library reference http://www.dinkumware.com/
11 .\" OpenGroup's Single Unix specification
12 .\" http://www.UNIX-systems.org/online.html
15 .\" Modified Tue Oct 16 23:18:40 BST 2001 by John Levon <moz@compsoc.man.ac.uk>
16 .TH FGETWC 3 1999-07-25 "GNU" "Linux Programmer's Manual"
18 fgetwc, getwc \- read a wide character from a FILE stream
25 .BI "wint_t fgetwc(FILE *" stream );
26 .BI "wint_t getwc(FILE *" stream );
29 The \fBfgetwc\fP() function is the wide-character equivalent of the \fBfgetc\fP()
30 function. It reads a wide character from \fIstream\fP and returns it. If
31 the end of stream is reached, or if \fIferror(stream)\fP becomes true,
32 it returns WEOF. If a wide character conversion error occurs, it sets
33 \fIerrno\fP to \fBEILSEQ\fP and returns WEOF.
35 The \fBgetwc\fP() function or macro functions identically to \fBfgetwc\fP().
36 It may be implemented as a macro, and may evaluate its argument
37 more than once. There is no reason ever to use it.
39 For non-locking counterparts, see
40 .BR unlocked_stdio (3).
42 The \fBfgetwc\fP() function returns the next wide-character from the stream, or
45 Apart from the usual ones, there is
48 The data obtained from the input stream does not
49 form a valid character.
53 The behaviour of \fBfgetwc\fP() depends on the LC_CTYPE category of the
56 In the absence of additional information passed to the
59 reasonable to expect that \fBfgetwc\fP() will actually read a multibyte sequence
60 from the stream and then convert it to a wide character.
65 .BR unlocked_stdio (3)