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)