NAME

iswcntrl, iswcntrl_l — test for a control wide-character code

SYNOPSIS

#include <wctype.h>

int iswcntrl(wint_t wc);


[CX] int iswcntrl_l(wint_t wc, locale_t locale);

DESCRIPTION

For iswcntrl(): ^[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-2024 defers to the ISO C standard.

The iswcntrl() ^[CX]  and iswcntrl_l()  functions shall test whether wc is a wide-character code representing a character of class cntrl in the current locale, ^[CX]  or in the locale represented by locale, respectively; see XBD 7. Locale.

The wc argument is a wint_t, the value of which the application shall ensure is a wide-character code corresponding to a valid character in the locale used by the function, or equal to the value of the macro WEOF. If the argument has any other value, the behavior is undefined.

^[CX] The behavior is undefined if the locale argument to iswcntrl_l() is the special locale object LC_GLOBAL_LOCALE or is not a valid locale object handle.

RETURN VALUE

The iswcntrl() ^[CX]  and iswcntrl_l()  functions shall return non-zero if wc is a control wide-character code; otherwise, they shall return 0.

ERRORS

No errors are defined.

EXAMPLES

None.

APPLICATION USAGE

To ensure applications portability, especially across natural languages, only these functions and the functions in the reference pages listed in the SEE ALSO section should be used for character classification.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

iswalnum, iswalpha, iswctype, iswdigit, iswgraph, iswlower, iswprint, iswpunct, iswspace, iswupper, iswxdigit, setlocale, uselocale

XBD 7. Locale, <locale.h>, <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 6

The normative text is updated to avoid use of the term "must" for application requirements.

Issue 7

The iswcntrl_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/0318 [302], XSH/TC1-2008/0319 [283], and XSH/TC1-2008/0320 [283] are applied.

POSIX.1-2008, Technical Corrigendum 2, XSH/TC2-2008/0183 [685] is applied.