xref: /illumos-gate/usr/src/man/man3c/getwchar.3c (revision f3682895b2a97c009685f16e8a4e5d3dc80e11f2)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
Copyright 2014 Garrett D'Amore <garrett@damore.org>

GETWCHAR 3C "June 20, 2021"
NAME
getwchar - get wide character from stdin stream
SYNOPSIS
#include <wchar.h>

wint_t getwchar(void)

#include <wchar.h>
#include <xlocale.h>

wint_t getwchar_l(locale_t loc)
DESCRIPTION
The getwchar() function is equivalent to getwc(stdin).

The getwchar_l() function is equivalent to getwc(stdin, loc).

RETURN VALUES
Refer to fgetwc(3C).
ERRORS
Refer to fgetwc(3C).
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 comparison may never succeed because wchar_t is defined as unsigned.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability See below.
MT-Level MT-Safe

The getwchar() function is Standard. The getwchar_l() function is Uncommitted.

SEE ALSO
fgetwc(3C), getwc(3C), attributes(5), standards(5)