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