1 '\" te
   2 .\" Copyright (c) 2003, X/Open Company Limited.  All Rights Reserved.  Portions Copyright (c) 1996, 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 FGETWC 3C "Oct 15, 2003"
  11 .SH NAME
  12 fgetwc, fgetwc_l \- get a wide-character code from a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18 
  19 \fBwint_t\fR \fBfgetwc\fR(\fBFILE*\fR\fIstream\fR);
  20 \fBwint_t\fR \fBfgetwc_l\fR(\fBFILE*\fR\fIstream\fR, \fBlocale_t\fR, \fIloc\fR);
  21 .fi
  22 
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBfgetwc()\fR and \fBfgetwc_l\fR functions obtains the next
  27 character (if present) from the input stream pointed to by \fIstream\fR,
  28 converts that to the corresponding wide-character code and advances the
  29 associated file position indicator for the stream (if defined). As
  30 opposed to using the current locale as determined by \fBsetlocale\fR(3C)
  31 and \fBuselocale\fR(3C), \fRfgetwc_l()\fR uses the locale passed in as
  32 \fBloc\fR.
  33 
  34 .sp
  35 .LP
  36 If an error occurs, the resulting value of the file position indicator for the
  37 stream is indeterminate.
  38 .sp
  39 .LP
  40 The \fBfgetwc()\fR and \fBfgetwc_l\fR functions may mark the \fBst_atime\fR field of the file
  41 associated with \fIstream\fR for update. The \fBst_atime\fR field will be
  42 marked for update by the first successful execution of \fBfgetwc()\fR,
  43 \fBfgetc\fR(3C), \fBfgets\fR(3C), \fBfgetws\fR(3C), \fBfread\fR(3C),
  44 \fBfscanf\fR(3C), \fBgetc\fR(3C), \fBgetchar\fR(3C), \fBgets\fR(3C), or
  45 \fBscanf\fR(3C) using \fIstream\fR that returns data not supplied by a prior
  46 call to \fBungetc\fR(3C) or \fBungetwc\fR(3C).
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 Upon successful completion both functions returns the
  51 wide-character code of the character read from the input stream pointed to by
  52 \fIstream\fR converted to a type \fBwint_t\fR.
  53 .sp
  54 .LP
  55 For standard-conforming (see \fBstandards\fR(5)) applications, if the
  56 end-of-file indicator for the stream is set, \fBfgetwc()\fR and
  57 \fBfgetwc_l()\fR returns \fBWEOF\fR whether or not the stream is at
  58 end-of-file.
  59 .sp
  60 .LP
  61 If a read error occurs, the error indicator for the stream is set,
  62 \fBfgetwc()\fR and \fBfgetwc_l()\fR returns \fBWEOF\fR and sets
  63 \fBerrno\fR to indicate the error.
  64 .sp
  65 .LP
  66 If an encoding error occurs, the error indicator for the stream is set,
  67 \fBfgetwc()\fR and \fBfgetwc_l()\fRreturns \fBWEOF\fR, and \fBerrno\fR is set to indicate the
  68 error.
  69 .SH ERRORS
  70 .sp
  71 .LP
  72 The \fBfgetwc()\fR and \fBfgetwc_l\fR functions will fail if data needs to be read and:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBEAGAIN\fR\fR
  77 .ad
  78 .RS 14n
  79 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
  80 \fIstream\fR and the process would be delayed in the \fBfgetwc()\fR or
  81 \fB fgetwc_l()\fR operation.
  82 .RE
  83 
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEBADF\fR\fR
  88 .ad
  89 .RS 14n
  90 The file descriptor underlying \fIstream\fR is not a valid file descriptor open
  91 for reading.
  92 .RE
  93 
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEINTR\fR\fR
  98 .ad
  99 .RS 14n
 100 The read operation was terminated due to the receipt of a signal, and no data
 101 was transferred.
 102 .RE
 103 
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEIO\fR\fR
 108 .ad
 109 .RS 14n
 110 A physical I/O error has occurred, or the process is in a background process
 111 group attempting to read from its controlling terminal and either the process
 112 is ignoring or blocking the \fBSIGTTIN\fR signal or the process group is
 113 orphaned.
 114 .RE
 115 
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBEOVERFLOW\fR \fR
 120 .ad
 121 .RS 14n
 122 The file is a regular file and an attempt was made to read at or beyond the
 123 offset maximum associated with the corresponding  \fIstream\fR.
 124 .RE
 125 
 126 .sp
 127 .LP
 128 The \fBfgetwc()\fR and \fBfgetwc_l()\fR functions may fail if:
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBENOMEM\fR\fR
 133 .ad
 134 .RS 10n
 135 Insufficient storage space is available.
 136 .RE
 137 
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBENXIO\fR\fR
 142 .ad
 143 .RS 10n
 144 A request was made of a non-existent device, or the request was outside the
 145 capabilities of the device.
 146 .RE
 147 
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBEILSEQ\fR\fR
 152 .ad
 153 .RS 10n
 154 The data obtained from the input stream does not form a valid character.
 155 .RE
 156 
 157 .SH USAGE
 158 .sp
 159 .LP
 160 The \fBferror\fR(3C) or \fBfeof\fR(3C) functions must be used to distinguish
 161 between an error condition and an end-of-file condition.
 162 .SH ATTRIBUTES
 163 .sp
 164 .LP
 165 See \fBattributes\fR(5) for descriptions of the following attributes:
 166 .sp
 167 
 168 .sp
 169 .TS
 170 box;
 171 l | l
 172 l | l .
 173 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 174 _
 175 CSI     Enabled
 176 _
 177 Interface Stability     Standard
 178 _
 179 MT-Level        MT-Safe with exceptions
 180 .TE
 181 
 182 .SH SEE ALSO
 183 .sp
 184 .LP
 185 \fBfeof\fR(3C), \fBferror\fR(3C), \fBfgetc\fR(3C), \fBfgets\fR(3C),
 186 \fBfgetws\fR(3C), \fBfopen\fR(3C), \fBfread\fR(3C), \fBfscanf\fR(3C),
 187 \fBgetc\fR(3C), \fBgetchar\fR(3C), \fBgets\fR(3C), \fBscanf\fR(3C),
 188 \fBsetlocale\fR(3C), \fBungetc\fR(3C), \fBungetwc\fR(3C), \fBattributes\fR(5),
 189 \fBstandards\fR(5)