xref: /illumos-gate/usr/src/man/man3c/getwc.3c (revision 7bb0eb348e1119aed76a61d633a9106b6b9912f1)

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>

GETWC 3C "Jul 11, 2014"
NAME
getwc, getwc_l - get wide character from a stream
SYNOPSIS

#include <stdio.h>
#include <wchar.h>

wint_t getwc(FILE *stream);

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

wint_t getwc_l(FILE *stream, locale_t loc);
DESCRIPTION

The getwc() function is equivalent to fgetwc(3C), except that if it is implemented as a macro it may evaluate stream more than once, so the argument should never be an expression with side effects.

The getwc_l() function is similar to getwc(), except instead of acting on the current locale, it uses the locale specified by loc.

RETURN VALUES

Refer to fgetwc(3C).

ERRORS

Refer to fgetwc(3C).

USAGE

This interface is provided to align with some current implementations and with possible future ISO standards.

Because they may be implemented as macros, these functions may treat incorrectly a stream argument with side effects. In particular, getwc(*f\|++) may not work as expected. Therefore, use of these functions is not recommended; fgetwc(3C) and fgetwc_l(3C) should be used instead.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability See below.
MT-Level MT-Safe

The getwc() function is Standard. The getwc_l() function is Uncommitted.

SEE ALSO

fgetwc (3C), newlocale (3C), setlocale (3C), uselocale (3C), attributes (7), standards (7)