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 GETWC 3C "Jul 11, 2014" 12 .SH NAME 13 getwc, getwc_l \- get wide character from a stream 14 .SH SYNOPSIS 15 .LP 16 .nf 17 #include <stdio.h> 18 #include <wchar.h> 19 20 \fBwint_t\fR \fBgetwc\fR(\fBFILE\fR \fI*stream\fR); 21 .fi 22 .LP 23 .nf 24 #include <stdio.h> 25 #include <wchar.h> 26 #include <xlocale.h> 27 28 \fBwint_t\fR \fBgetwc_l\fR(\fBFILE\fR \fI*stream\fR, \fBlocale_t\fR \fIloc\fR); 29 .fi 30 31 .SH DESCRIPTION 32 .sp 33 .LP 34 The \fBgetwc()\fR function is equivalent to \fBfgetwc\fR(3C), except that if it 35 is implemented as a macro it may evaluate \fIstream\fR more than once, so the 36 argument should never be an expression with side effects. 37 .LP 38 The \fBgetwc_l()\fR function is similar to \fBgetwc()\fR, except instead of 39 acting on the current locale, it uses the locale specified by \fIloc\fR. 40 .SH RETURN VALUES 41 .LP 42 Refer to \fBfgetwc\fR(3C). 43 .SH ERRORS 44 .LP 45 Refer to \fBfgetwc\fR(3C). 46 .SH USAGE 47 .LP 48 This interface is provided to align with some current implementations and with 49 possible future \fBISO\fR standards. 50 .LP 51 Because they may be implemented as macros, these functions may treat incorrectly 52 a \fIstream\fR argument with side effects. In particular, 53 \fBgetwc\fR(*\fIf\fR\|++) may not work as expected. Therefore, use of these 54 functions is not recommended; \fBfgetwc\fR(3C) and \fBfgetwc_l\fR(3C) 55 should be used instead. 56 .SH ATTRIBUTES 57 .LP 58 See \fBattributes\fR(5) for descriptions of the following attributes: 59 .TS 60 box; 61 c | c 62 l | l . 63 ATTRIBUTE TYPE ATTRIBUTE VALUE 64 _ 65 Interface Stability See below. 66 _ 67 MT-Level MT-Safe 68 .TE 69 70 .LP 71 The 72 .B getwc() 73 function is Standard. The 74 .B getwc_l() 75 function is Uncommitted. 76 .SH SEE ALSO 77 .LP 78 \fBfgetwc\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C), 79 \fBattributes\fR(5), \fBstandards\fR(5)