iOS Manual Pages

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

GETWC(3)                 BSD Library Functions Manual                 GETWC(3)

NAME
     fgetwc, getwc, getwchar -- get next wide character from input stream

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <stdio.h>
     #include <wchar.h>

     wint_t
     fgetwc(FILE *stream);

     wint_t
     getwc(FILE *stream);

     wint_t
     getwchar(void);

DESCRIPTION
     The fgetwc() function obtains the next input wide character (if present)
     from the stream pointed at by stream, or the next character pushed back
     on the stream via ungetwc(3).

     The getwc() function acts essentially identically to fgetwc().

     The getwchar() function is equivalent to getwc() with the argument stdin.

     Extended locale versions of these functions are documented in getwc_l(3).
     See xlocale(3) for more information.

RETURN VALUES
     If successful, these routines return the next wide character from the
     stream.  If the stream is at end-of-file or a read error occurs, the rou-tines routines
     tines return WEOF.  The routines feof(3) and ferror(3) must be used to
     distinguish between end-of-file and error.  If an error occurs, the
     global variable errno is set to indicate the error.  The end-of-file con-dition condition
     dition is remembered, even on a terminal, and all subsequent attempts to
     read will return WEOF until the condition is cleared with clearerr(3).

SEE ALSO
     ferror(3), fopen(3), fread(3), getc(3), getwc_l(3), putwc(3), stdio(3),
     ungetwc(3)

STANDARDS
     The fgetwc(), getwc(), and getwchar() functions conform to ISO/IEC
     9899:1999 (``ISO C99'').

BSD                              March 3, 2004                             BSD