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

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
  45 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  46 .\"
  47 .TH GETWC 3C "Jul 11, 2014"
  48 .SH NAME
  49 getwc, getwc_l \- get wide character from a stream
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdio.h>
  54 #include <wchar.h>
  55
  56 \fBwint_t\fR \fBgetwc\fR(\fBFILE\fR \fI*stream\fR);
  57 .fi
  58 .LP
  59 .nf
  60 #include <stdio.h>
  61 #include <wchar.h>
  62 #include <xlocale.h>
  63
  64 \fBwint_t\fR \fBgetwc_l\fR(\fBFILE\fR \fI*stream\fR, \fBlocale_t\fR \fIloc\fR);
  65 .fi
  66
  67 .SH DESCRIPTION
  68 .sp
  69 .LP
  70 The \fBgetwc()\fR function is equivalent to \fBfgetwc\fR(3C), except that if it
  71 is implemented as a macro it may evaluate \fIstream\fR more than once, so the
  72 argument should never be an expression with side effects.
  73 .LP
  74 The \fBgetwc_l()\fR function is similar to \fBgetwc()\fR, except instead of
  75 acting on the current locale, it uses the locale specified by \fIloc\fR.
  76 .SH RETURN VALUES
  77 .LP
  78 Refer to \fBfgetwc\fR(3C).
  79 .SH ERRORS
  80 .LP
  81 Refer to \fBfgetwc\fR(3C).
  82 .SH USAGE
  83 .LP
  84 This interface is provided to align with some current implementations and with
  85 possible future \fBISO\fR standards.
  86 .LP
  87 Because they may be implemented as macros, these functions may treat incorrectly
  88 a \fIstream\fR argument with side effects.  In particular,
  89 \fBgetwc\fR(*\fIf\fR\|++) may not work as expected.  Therefore, use of these
  90 functions is not recommended; \fBfgetwc\fR(3C) and \fBfgetwc_l\fR(3C)
  91 should be used instead.
  92 .SH ATTRIBUTES
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     See below.
 102 _
 103 MT-Level        MT-Safe
 104 .TE
 105
 106 .LP
 107 The
 108 .B getwc()
 109 function is Standard.  The
 110 .B getwc_l()
 111 function is Uncommitted.
 112 .SH SEE ALSO
 113 .LP
 114 \fBfgetwc\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
 115 \fBattributes\fR(5), \fBstandards\fR(5)