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