NAME

wctype, wctype_l - define character class

SYNOPSIS

#include <wctype.h>

wctype_t wctype(const char *property);


[CX] wctype_t wctype_l(const char *property, locale_t locale);

DESCRIPTION

For wctype(): ^[CX]  The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.

The wctype() ^[CX]  and wctype_l()  functions are defined for valid character class names as defined in the current locale ^[CX]  or in the locale represented by locale,  respectively.

The property argument is a string identifying a generic character class for which codeset-specific type information is required. The following character class names shall be 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.

These functions shall return a value of type wctype_t, which can be used as the second argument to subsequent calls of iswctype() ^[CX]  and iswctype_l().

The wctype() ^[CX]  and wctype_l()  functions shall determine values of wctype_t according to the rules of the coded character set defined by character type information in the current locale ^[CX]  or in the locale represented by locale,  respectively (category LC_CTYPE).

The values returned by wctype() shall be valid until a call to setlocale() that modifies the category LC_CTYPE.

^[CX] The values returned by wctype_l() shall be valid only in calls to iswctype_l() with a locale represented by locale with the same LC_CTYPE category value.

The behavior is undefined if the locale argument to wctype_l() is the special locale object LC_GLOBAL_LOCALE or is not a valid locale object handle.

RETURN VALUE

The wctype() ^[CX]  and wctype_l()  functions shall return 0 if the given character class name is not valid for the current locale (category LC_CTYPE); otherwise, they shall return an object of type wctype_t that can be used in calls to iswctype() ^[CX]  and iswctype_l().

ERRORS

No errors are defined.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

iswctype

XBD <wctype.h>

CHANGE HISTORY

First released in Issue 4.

Issue 5

The following change has been made in this version for alignment with ISO/IEC 9899:1990/Amendment 1:1995 (E):

• The SYNOPSIS has been changed to indicate that this function and associated data types are now made visible by inclusion of the <wctype.h> header rather than <wchar.h>.

Issue 7

The wctype_l() function is added from The Open Group Technical Standard, 2006, Extended API Set Part 4.

POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0736 [302], XSH/TC1-2008/0737 [283], and XSH/TC1-2008/0738 [283] are applied.