usr/src/man/man3c/getwc.3c

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH GETWC 3C "Jul 24, 2002"
  11 .SH NAME
  12 getwc \- get wide character from a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18
  19 \fBwint_t\fR \fBgetwc\fR(\fBFILE\fR \fI*stream\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBgetwc()\fR function is equivalent to \fBfgetwc\fR(3C), except that if it
  26 is implemented as a macro it may evaluate \fIstream\fR more than once, so the
  27 argument should never be an expression with side effects.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 Refer to \fBfgetwc\fR(3C).
  32 .SH ERRORS
  33 .sp
  34 .LP
  35 Refer to \fBfgetwc\fR(3C).
  36 .SH USAGE
  37 .sp
  38 .LP
  39 This interface is provided to align with some current implementations and with
  40 possible future \fBISO\fR standards.
  41 .sp
  42 .LP
  43 Because it may be implemented as a macro, \fBgetwc()\fR may treat incorrectly a
  44 \fIstream\fR argument with side effects.  In particular,
  45 \fBgetwc\fR(*\fIf\fR\|++) may not work as expected.  Therefore, use of this
  46 function is not recommended; \fBfgetwc\fR(3C) should be used instead.
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 _
  60 Interface Stability     Standard
  61 _
  62 MT-Level        MT-Safe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBfgetwc\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)