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