getwchar - Man Page

read a wide character from standard input

Library

Standard C library (libc, -lc)

Synopsis

#include <wchar.h>

wint_t getwchar(void);

Description

The getwchar() function is the wide-character equivalent of the getchar(3) function. It reads a wide character from stdin and returns it. If the end of stream is reached, or if ferror(stdin) becomes true, it returns WEOF. If a wide-character conversion error occurs, it sets errno to EILSEQ and returns WEOF.

For a nonlocking counterpart, see unlocked_stdio(3).

Return Value

The getwchar() function returns the next wide-character from standard input, or WEOF.

Attributes

For an explanation of the terms used in this section, see attributes(7).

InterfaceAttributeValue
getwchar()Thread safetyMT-Safe

Standards

POSIX.1-2001, POSIX.1-2008, C99.

Notes

The behavior of getwchar() depends on the LC_CTYPE category of the current locale.

It is reasonable to expect that getwchar() will actually read a multibyte sequence from standard input and then convert it to a wide character.

See Also

fgetwc(3), unlocked_stdio(3)

Referenced By

fgetc(3), gets(3).

2022-10-09 Linux man-pages 6.01