xref: /illumos-gate/usr/src/man/man3head/wchar.h.3head (revision e3ae4b35c024af1196582063ecee3ab79367227d)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2014 Garrett D'Amore <garrett@damore.org>

WCHAR.H 3HEAD "Aug 15, 2014"
NAME
wchar.h, wchar - wide-character handling
SYNOPSIS

#include <wchar.h>
DESCRIPTION

The <wchar.h> header defines the following types: wchar_t

As described in <stddef.h>.

wint_t

An integer type capable of storing any valid value of wchar_t or WEOF.

wctype_t

A scalar type of a data object that can hold values which represent locale-specific character classification.

mbstate_t

An object type other than an array type that can hold the conversion state information necessary to convert between sequences of (possibly multi-byte) characters and wide characters. If a codeset is being used such that an mbstate_t needs to preserve more than two levels of reserved state, the results are unspecified.

FILE

As described in <stdio.h>.

size_t

As described in <stddef.h>.

va_list

As described in <stdarg.h>.

The implementation supports one or more programming environments in which the width of wint_t is no greater than the width of type long. The names of these programming environments can be obtained using the confstr(3C) function or the getconf(1) utility.

The <wchar.h> header defines the following macros: WCHAR_MAX

The maximum value representable by an object of type wchar_t.

WCHAR_MIN

The minimum value representable by an object of type wchar_t.

WEOF

Constant expression of type wint_t that is returned by several WP functions to indicate end-of-file.

NULL

As described in <stddef.h>.

The tag tm is declared as naming an incomplete structure type, the contents of which are described in the header <time.h>.

Inclusion of the <wchar.h> header can make visible all symbols from the headers <ctype.h>, <string.h>, <stdarg.h>, <stddef.h>, <stdio.h>, <stdlib.h>, and <time.h>.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO
getconf (1), btowc (3C), confstr (3C), fgetwc (3C), fputwc (3C), fputws (3C), fwide (3C), fwprintf (3C), fwscanf (3C), getwc (3C), getwchar (3C), getws (3C), iswalpha (3C), iswctype (3C), mbrlen (3C), mbrtowc (3C), mbsinit (3C), mbsrtowcs (3C), towlower (3C), towupper (3C), ungetwc (3C), vfwprintf (3C), wcpcpy (3C), wcrtomb (3C), wcscasecmp (3C), wcscoll (3C), wcsdup (3C), wcsftime (3C), wcslen (3C), wcsrtombs (3C), wcsstr (3C), wcstod (3C), wcstol (3C), wcstoul (3C), wcstring (3C), wcswidth (3C), wcsxfrm (3C), wctob (3C), wctype (3C), wcwidth (3C), wmemchr (3C), wmemcmp (3C), wmemcpy (3C), wmemmove (3C), wmemset (3C), stdarg (3EXT), stddef.h (3HEAD), stdio.h (3HEAD), stdlib.h (3HEAD), string.h (3HEAD), time.h (3HEAD), wctype.h (3HEAD), attributes (7), standards (7)