1 '\" te
2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, 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 WCHAR.H 3HEAD "Sep 10, 2004"
11 .SH NAME
12 wchar.h, wchar \- wide-character handling
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <\fBwchar.h\fR>
17 .fi
18
19 .SH DESCRIPTION
20 .sp
21 .LP
22 The <\fBwchar.h\fR> header defines the following types:
23 .sp
24 .ne 2
25 .na
26 \fB\fBwchar_t\fR\fR
27 .ad
28 .RS 13n
29 As described in <\fBstddef.h\fR>.
30 .RE
31
32 .sp
33 .ne 2
34 .na
35 \fB\fBwint_t\fR\fR
36 .ad
37 .RS 13n
38 An integer type capable of storing any valid value of \fBwchar_t\fR or
39 \fBWEOF\fR.
40 .RE
41
42 .sp
43 .ne 2
44 .na
45 \fB\fBwctype_t\fR\fR
46 .ad
47 .RS 13n
48 A scalar type of a data object that can hold values which represent
49 locale-specific character classification.
50 .RE
51
52 .sp
53 .ne 2
54 .na
55 \fB\fBmbstate_t\fR\fR
56 .ad
57 .RS 13n
58 An object type other than an array type that can hold the conversion state
59 information necessary to convert between sequences of (possibly multi-byte)
60 characters and wide characters. If a codeset is being used such that an
61 \fBmbstate_t\fR needs to preserve more than two levels of reserved state, the
62 results are unspecified.
63 .RE
64
65 .sp
66 .ne 2
67 .na
68 \fB\fBFILE\fR\fR
69 .ad
70 .RS 13n
71 As described in <\fBstdio.h\fR>.
72 .RE
73
74 .sp
75 .ne 2
76 .na
77 \fB\fBsize_t\fR\fR
78 .ad
79 .RS 13n
80 As described in <\fBstddef.h\fR>.
81 .RE
82
83 .sp
84 .ne 2
85 .na
86 \fB\fBva_list\fR\fR
87 .ad
88 .RS 13n
89 As described in <\fBstdarg.h\fR>.
90 .RE
91
92 .sp
93 .LP
94 The implementation supports one or more programming environments in which the
95 width of \fBwint_t\fR is no greater than the width of type \fBlong\fR. The
96 names of these programming environments can be obtained using the
97 \fBconfstr\fR(3C) function or the \fBgetconf\fR(1) utility.
98 .sp
99 .LP
100 The <\fBwchar.h\fR> header defines the following macros:
101 .sp
102 .ne 2
103 .na
104 \fB\fBWCHAR_MAX\fR\fR
105 .ad
106 .RS 13n
107 The maximum value representable by an object of type \fBwchar_t\fR.
108 .RE
109
110 .sp
111 .ne 2
112 .na
113 \fB\fBWCHAR_MIN\fR\fR
114 .ad
115 .RS 13n
116 The minimum value representable by an object of type \fBwchar_t\fR.
117 .RE
118
119 .sp
120 .ne 2
121 .na
122 \fB\fBWEOF\fR\fR
123 .ad
124 .RS 13n
125 Constant expression of type \fBwint_t\fR that is returned by several WP
126 functions to indicate end-of-file.
127 .RE
128
129 .sp
130 .ne 2
131 .na
132 \fB\fBNULL\fR\fR
133 .ad
134 .RS 13n
135 As described in <\fBstddef.h\fR>.
136 .RE
137
138 .sp
139 .LP
140 The tag \fBtm\fR is declared as naming an incomplete structure type, the
141 contents of which are described in the header <\fBtime.h\fR>.
142 .sp
143 .LP
144 Inclusion of the <\fBwchar.h\fR> header can make visible all symbols from the
145 headers <\fBctype.h\fR>, <\fBstring.h\fR>, <\fBstdarg.h\fR>, <\fBstddef.h\fR>,
146 <\fBstdio.h\fR>, <\fBstdlib.h\fR>, and <\fBtime.h\fR>.
147 .SH ATTRIBUTES
148 .sp
149 .LP
150 See \fBattributes\fR(5) for descriptions of the following attributes:
151 .sp
152
153 .sp
154 .TS
155 box;
156 c | c
157 l | l .
158 ATTRIBUTE TYPE ATTRIBUTE VALUE
159 _
160 Interface Stability Standard
161 .TE
162
163 .SH SEE ALSO
164 .sp
165 .LP
166 \fBgetconf\fR(1), \fBbtowc\fR(3C), \fBconfstr\fR(3C), \fBfgetwc\fR(3C),
167 \fBgetws\fR(3C), \fBfputwc\fR(3C), \fBfputws\fR(3C), \fBfwide\fR(3C),
168 \fBfwprintf\fR(3C), \fBfwscanf\fR(3C), \fBgetwc\fR(3C), \fBgetwchar\fR(3C),
169 \fBiswalpha\fR(3C), \fBiswctype\fR(3C), \fBmbsinit\fR(3C), \fBmbrlen\fR(3C),
170 \fBmbrtowc\fR(3C), \fBmbsrtowcs\fR(3C), \fBtowlower\fR(3C), \fBtowupper\fR(3C),
171 \fBungetwc\fR(3C), \fBvfwprintf\fR(3C), \fBwcrtomb\fR(3C), \fBwcsrtombs\fR(3C),
172 \fBwcstring\fR(3C), \fBwcsstr\fR(3C), \fBwcstod\fR(3C), \fBwcscoll\fR(3C),
173 \fBwcsftime\fR(3C), \fBwcstol\fR(3C), \fBwcstoul\fR(3C), \fBwcswidth\fR(3C),
174 \fBwcsxfrm\fR(3C), \fBwctob\fR(3C), \fBwctype\fR(3C), \fBwcwidth\fR(3C),
175 \fBwmemchr\fR(3C), \fBwmemcmp\fR(3C), \fBwmemcpy\fR(3C), \fBwmemmove\fR(3C),
176 \fBwmemset\fR(3C), \fBstdarg\fR(3EXT), \fBstddef.h\fR(3HEAD),
177 \fBstdio.h\fR(3HEAD), \fBstdlib.h\fR(3HEAD), \fBstring.h\fR(3HEAD),
178 \fBtime.h\fR(3HEAD), \fBwctype.h\fR(3HEAD), \fBattributes\fR(5),
179 \fBstandards\fR(5)
|
1 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, 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 .Dd "Jul 27, 2014"
11 .Dt WCHAR.H 3HEAD
12 .Os
13 .Sh NAME
14 .Nm wchar.h ,
15 .Nm wchar
16 .Nd wide-character handling
17 .Sh SYNOPSIS
18 .In wchar.h
19 .Sh DESCRIPTION
20 The
21 .In wchar.h
22 header defines the following types:
23 .Bl -tag -width Vt
24 .
25 .It Vt wchar_t
26 As described in
27 .In stddef.h .
28 .
29 .It Vt wint_t
30 An integer type capable of storing any valid value of
31 .Vt wchar_t
32 or
33 .Dv WEOF .
34 .
35 .It Vt wctype_t
36 A scalar type of a data object that can hold values which represent
37 locale-specific character classification.
38 .
39 .It Vt locale_t
40 As described in
41 .In locale.h .
42 .
43 .It Vt mbstate_t
44 An object type other than an array type that can hold the conversion state
45 information necessary to convert between sequences of (possibly multi-byte)
46 characters and wide characters. If a codeset is being used such that an
47 .Vt mbstate_t
48 needs to preserve more than two levels of reserved state, the
49 results are unspecified.
50 .
51 .It Vt FILE
52 As described in
53 .In stdio.h .
54 .
55 .It Vt size_t
56 As described in
57 .In stddef.h .
58 .
59 .It Vt va_list
60 As described in
61 .In stdarg.h .
62 .El
63 .
64 .Lp
65 The implementation supports one or more programming environments in which the
66 width of
67 .Vt wint_t
68 is no greater than the width of type
69 .Vt long .
70 The names of these programming environments can be obtained using the
71 .Xr confstr 3C
72 function or the
73 .Xr getconf 1
74 utility.
75 .Lp
76 The
77 .In wchar.h
78 header defines the following macros:
79 .Bl -tag -width Dv
80 .
81 .It Dv WCHAR_MAX
82 The maximum value representable by an object of type
83 .Vt wchar_t .
84 .
85 .It Dv WCHAR_MIN
86 The minimum value representable by an object of type
87 .Vt wchar_t .
88 .
89 .It Dv WEOF
90 Constant expression of type
91 .Vt wint_t
92 that is returned by certain wide-character functions to indicate end-of-file.
93 .
94 .It Dv NULL
95 As described in
96 .In stddef.h .
97 .El
98 .Lp
99 The tag
100 .Vt tm
101 is declared as naming an incomplete structure type, the
102 contents of which are described in the header
103 .In time.h .
104 .Lp
105 Inclusion of the
106 .In wchar.h
107 header can make visible all symbols from the headers
108 .In ctype.h ,
109 .In string.h ,
110 .In stdarg.h ,
111 .In stddef.h ,
112 .In stdio.h ,
113 .In stdlib.h ,
114 and
115 .In time.h .
116 .Sh INTERFACE STABILITY
117 .Sy Standard .
118 .Sh SEE ALSO
119 .Xr getconf 1 ,
120 .Xr btowc 3C ,
121 .Xr confstr 3C ,
122 .Xr fgetwc 3C ,
123 .Xr getws 3C ,
124 .Xr fputwc 3C ,
125 .Xr fputws 3C ,
126 .Xr fwide 3C ,
127 .Xr fwprintf 3C ,
128 .Xr fwscanf 3C ,
129 .Xr getwc 3C ,
130 .Xr getwchar 3C ,
131 .Xr iswalpha 3C ,
132 .Xr iswctype 3C ,
133 .Xr mbsinit 3C ,
134 .Xr mbrlen 3C ,
135 .Xr mbrtowc 3C ,
136 .Xr mbsrtowcs 3C ,
137 .Xr towlower 3C ,
138 .Xr towupper 3C ,
139 .Xr ungetwc 3C ,
140 .Xr vfwprintf 3C ,
141 .Xr wcrtomb 3C ,
142 .Xr wcsrtombs 3C ,
143 .Xr wcstring 3C ,
144 .Xr wcsstr 3C ,
145 .Xr wcstod 3C ,
146 .Xr wcscoll 3C ,
147 .Xr wcsdup 3C ,
148 .Xr wcsftime 3C ,
149 .Xr wcslen 3C ,
150 .Xr wcstol 3C ,
151 .Xr wcstoul 3C ,
152 .Xr wcswidth 3C ,
153 .Xr wcsxfrm 3C ,
154 .Xr wctob 3C ,
155 .Xr wctype 3C ,
156 .Xr wcwidth 3C ,
157 .Xr wmemchr 3C ,
158 .Xr wmemcmp 3C ,
159 .Xr wmemcpy 3C ,
160 .Xr wmemmove 3C ,
161 .Xr wmemset 3C ,
162 .Xr stdarg 3EXT ,
163 .Xr stddef.h 3HEAD ,
164 .Xr stdio.h 3HEAD ,
165 .Xr stdlib.h 3HEAD ,
166 .Xr string.h 3HEAD ,
167 .Xr time.h 3HEAD ,
168 .Xr wctype.h 3HEAD ,
169 .Xr standards 5)
170 .Sh STANDARDS
171 The
172 .In wchar.h
173 header was introduced in
174 .St -xpg4 .
|