getwchar.3p (2402B)
- '\" et
- .TH GETWCHAR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
- .\"
- .SH 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.
- .\"
- .SH NAME
- getwchar
- \(em get a wide character from a
- .IR stdin
- stream
- .SH SYNOPSIS
- .LP
- .nf
- #include <wchar.h>
- .P
- wint_t getwchar(void);
- .fi
- .SH 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\(hy2017 defers to the ISO\ C standard.
- .P
- The
- \fIgetwchar\fR()
- function shall be equivalent to \fIgetwc\fP(\fIstdin\fP).
- .SH "RETURN VALUE"
- Refer to
- .IR "\fIfgetwc\fR\^(\|)".
- .SH ERRORS
- Refer to
- .IR "\fIfgetwc\fR\^(\|)".
- .LP
- .IR "The following sections are informative."
- .SH EXAMPLES
- None.
- .SH "APPLICATION USAGE"
- If the
- .BR wint_t
- value returned by
- \fIgetwchar\fR()
- is stored into a variable of type
- .BR wchar_t
- and then compared against the
- .BR wint_t
- macro WEOF, the result may be incorrect. Only the
- .BR wint_t
- type is guaranteed to be able to represent any wide character and
- WEOF.
- .SH RATIONALE
- None.
- .SH "FUTURE DIRECTIONS"
- None.
- .SH "SEE ALSO"
- .IR "Section 2.5" ", " "Standard I/O Streams",
- .IR "\fIfgetwc\fR\^(\|)",
- .IR "\fIgetwc\fR\^(\|)"
- .P
- The Base Definitions volume of POSIX.1\(hy2017,
- .IR "\fB<wchar.h>\fP"
- .\"
- .SH COPYRIGHT
- Portions of this text are reprinted and reproduced in electronic form
- from IEEE Std 1003.1-2017, Standard for Information Technology
- -- Portable Operating System Interface (POSIX), The Open Group Base
- Specifications Issue 7, 2018 Edition,
- Copyright (C) 2018 by the Institute of
- Electrical and Electronics Engineers, Inc and The Open Group.
- In the event of any discrepancy between this version and the original IEEE and
- The Open Group Standard, the original IEEE and The Open Group Standard
- is the referee document. The original Standard can be obtained online at
- http://www.opengroup.org/unix/online.html .
- .PP
- Any typographical or formatting errors that appear
- in this page are most likely
- to have been introduced during the conversion of the source files to
- man page format. To report such errors, see
- https://www.kernel.org/doc/man-pages/reporting_bugs.html .