1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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 Sun OS 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH GETWCHAR 3C "Jul 24, 2002"
  12 .SH NAME
  13 getwchar \- get wide character from stdin stream
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <wchar.h>
  18 
  19 \fBwint_t\fR \fBgetwchar\fR(void)
  20 .fi
  21 .LP
  22 .nf
  23 #include <wchar.h>
  24 #include <xlocale.h>
  25 
  26 \fBwint_t\fR \fBgetwchar_l\fR(locale_t loc)
  27 .fi
  28 .SH DESCRIPTION
  29 .LP
  30 The \fBgetwchar()\fR function is equivalent to \fBgetwc\fR(\fBstdin\fR).
  31 .LP
  32 The\fBgetwchar_l()\fR function is equivalent to \fBgetwc\fR(\fBstdin\fR, \fIloc\fR).
  33 .SH RETURN VALUES
  34 .LP
  35 Refer to \fBfgetwc\fR(3C).
  36 .SH ERRORS
  37 .LP
  38 Refer to \fBfgetwc\fR(3C).
  39 .SH USAGE
  40 .LP
  41 If the \fBwint_t\fR value returned by \fBgetwchar()\fR is stored into a
  42 variable of type \fBwchar_t\fR and then compared against the \fBwint_t\fR macro
  43 \fBWEOF\fR, the comparison may never succeed because \fBwchar_t\fR is defined
  44 as unsigned.
  45 .SH ATTRIBUTES
  46 .LP
  47 See \fBattributes\fR(5) for descriptions of the following attributes:
  48 .TS
  49 box;
  50 c | c
  51 l | l .
  52 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  53 _
  54 Interface Stability     See below.
  55 _
  56 MT-Level        MT-Safe
  57 .TE
  58 
  59 .LP
  60 The \fBgetwchar()\fR function is Standard.  The \fBgetwchar_l()\fR function
  61 is Uncommitted.
  62 .SH SEE ALSO
  63 .LP
  64 \fBfgetwc\fR(3C), \fBgetwc\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)