getwchar man page

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

getwchar — get a wide character from a stdin stream

Synopsis

#include <wchar.h>

wint_t getwchar(void);

Description

The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2008 defers to the ISO C standard.

The getwchar() function shall be equivalent to getwc(stdin).

Return Value

Refer to fgetwc().

Errors

Refer to fgetwc().

The following sections are informative.

Examples

None.

Application Usage

If the wint_t value returned by getwchar() is stored into a variable of type wchar_t and then compared against the wint_t macro WEOF, the result may be incorrect. Only the wint_t type is guaranteed to be able to represent any wide character and WEOF.

Rationale

None.

Future Directions

None.

See Also

Section 2.5, Standard I/O Streams, fgetwc(), getwc()

The Base Definitions volume of POSIX.1-2008, <wchar.h>

Referenced By

wchar.h(0p).

2013 IEEE/The Open Group POSIX Programmer's Manual