getwc(3)

getwc3

Get next wide character from input stream

Usage

#include <stdio.h>

#include <wchar.h>

wint_t

fgetwc(FILE *stream);

wint_t

getwc(FILE *stream);

wint_t

getwchar(void);

Library

Standard C Library (libc, -lc)

Overview

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 routines 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 condition is remembered, even on a terminal, and all subsequent attempts to read will return WEOF until the condition is cleared with clearerr(3).

Releases

145 releases since Mac OS X 10.3; the text changed 3 times.

  1. 10.3–10.3.9
  2. 10.4–10.4.11
  3. 10.5–10.6.8
  4. 10.7–26.5

Standards

The fgetwc(), getwc(), and getwchar() functions conform to ISO/IEC 9899:1999 (“ISO C99”).

From Libc 1752.120.2 in macOS 26.5. Parsed by carta from the page's mdoc source.