xref: /illumos-gate/usr/src/man/man3c/iswctype.3c (revision bbf21555)

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>

ISWCTYPE 3C "Jul 26, 2014"
NAME
iswctype - test character for specified class
SYNOPSIS

#include <wchar.h>

int iswctype(wint_t wc, wctype_t charclass);

int iswctype(wint_t wc, wctype_t charclass, locale_t loc);
DESCRIPTION

The iswctype() and iswctype_l() functions determine whether the wide-character code wc is a member of the character class charclass , returning TRUE or FALSE . These functions are defined on WEOF and wide-character codes corresponding to the valid character encodings in the current locale (or loc for iswctype_l() .) If the wc argument is not in the domain of the function, the result is undefined. If the value of charclass is invalid (that is, not obtained by a call to wctype (3C) or obtained from a different locale), the result is indeterminate.

Whereas iswctype() operates in the current locale, iswctype_l() operates in the locale specified with loc .

RETURN VALUES

These functions return 0 for FALSE and non-zero for TRUE .

USAGE

There are twelve strings that are reserved for the standard character classes:

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

In the table below, the functions in the left column are equivalent to the functions in the right column.

iswalnum(wc) iswctype(wc, wctype("alnum"))
iswalpha(wc) iswctype(wc, wctype("alpha"))
iswcntrl(wc) iswctype(wc, wctype("cntrl"))
iswdigit(wc) iswctype(wc, wctype("digit"))
iswgraph(wc) iswctype(wc, wctype("graph"))
iswlower(wc) iswctype(wc, wctype("lower"))
iswprint(wc) iswctype(wc, wctype("print"))
iswpunct(wc) iswctype(wc, wctype("punct"))
iswspace(wc) iswctype(wc, wctype("space"))
iswupper(wc) iswctype(wc, wctype("upper"))
iswxdigit(wc) iswctype(wc, wctype("xdigit"))

The call

iswctype(wc, wctype("blank"))

does not have an equivalent isw*(\|) function.

ATTRIBUTES

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

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

iswalpha (3C), newlocale (3C), setlocale (3C), uselocale (3C), wctype (3C), attributes (7), standards (7)