xref: /illumos-gate/usr/src/man/man3c/wctype.3c (revision 241c90a06e8d1708235651863df515a2d522a03a)

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) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
Copyright 2014 Garrett D'Amore <garrett@damore.org>

WCTYPE 3C "Jun 25, 2014"
NAME
wctype, wctype_l - define character class
SYNOPSIS

#include <wchar.h>

wctype_t wctype(const char *charclass);

wctype_t wctype_l(const char *charclass, locale_t loc);
DESCRIPTION

The wctype() function is defined for valid character class names as defined in the current locale. The charclass is a string identifying a generic character class for which codeset-specific type information is required. The following character class names are defined in all locales:

"alnum" "alpha" "blank"
"cntrl" "digit" "graph"
"lower" "print" "punct"
"space" "upper" "xdigit"

Additional character class names defined in the locale definition file (category LC_CTYPE) can also be specified.

The function returns a value of type wctype_t, which can be used as the second argument to subsequent calls of iswctype(3C). The wctype() function determines values of wctype_t according to the rules of the coded character set defined by character type information in the current locale (category LC_CTYPE). The values returned by wctype() are valid only in the locale, or locales with the same LC_CTYPE category.

The function wctype_l() behaves identically to wctype(), except instead of operating in the current locale, it operates in the locale specified by loc.

RETURN VALUES

These functions return 0 if the given character class name is not valid for the locale (category LC_CTYPE); otherwise it returns an object of type wctype_t that can be used in calls to iswctype(3C).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

iswctype(3C), newlocale(3C), setlocale(3C), uselocale(3C), attributes(5), standards(5)