ISWCNTRL(3POSIX)

πŸ’– ISWCNTRL(3POSIX) πŸ’–

okay bestie, welcome to the POSIX Programmer's Manual β€” yes that's the whole manual, and yes this page is part of it. sit down, hydrate, we're learning about control wide-character codes πŸŽ€


✨ PROLOG ✨

so like, heads up first: this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ β€” so if you're on Linux, pls consult the corresponding Linux manual page for the deets on Linux behavior. or, plot twist, the interface might not even be implemented on Linux at all. πŸ’€ vibe check accordingly.


🌸 NAME 🌸

iswcntrl, iswcntrl_l β€” test for a control wide-character code. that's it. that's the job. πŸ¦‹


✨ SYNOPSIS ✨

#include <wctype.h>

int iswcntrl(wint_t wc);
int iswcntrl_l(wint_t wc, locale_t locale);

two functions, one header, we love a clean entrance. πŸ’…


πŸŽ€ DESCRIPTION πŸŽ€

okay so for iswcntrl(): the functionality described on this reference page is aligned with the ISO C standard. and if there's any conflict between the requirements described here and the ISO C standard? that's unintentional, fr fr. this volume of POSIX.1‐2017 defers to the ISO C standard. the ISO C standard is the main character here, we're just supporting cast. πŸ‘‘

now the actual tea: iswcntrl() and iswcntrl_l() shall test whether wc is a wide-character code representing a character of class cntrl in the current locale, or in the locale represented by locale, respectively. see the Base Definitions volume of POSIX.1‐2017, Chapter 7, Locale. πŸ—ΊοΈ

the wc argument is a wint_t, and the value of it? the application shall ensure it's 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.

🚨 and if the argument has any other value? the behavior is undefined. not a vibe. don't do it. 😭

also, the behavior is undefined if the locale argument to iswcntrl_l() is the special locale object LC_GLOBAL_LOCALE, or if it's not a valid locale object handle. like, invalid locale handle = chaos. πŸ™ˆ


⭐ RETURN VALUE ⭐

iswcntrl() and iswcntrl_l() shall return non-zero if wc is a control wide-character code. otherwise? they shall return 0. simple. binary. iconic. ✨


πŸ’€ ERRORS πŸ’€

No errors are defined.

the following sections are informative. (translation: the drama is over, the rest is bonus content πŸ“)


🌈 EXAMPLES 🌈

None.

not one example. we're on our own, bestie. 🫢


πŸ’œ 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. don't freestyle with random stuff, iykyk. 🌍


πŸ¦‹ RATIONALE πŸ¦‹

None.


🧚 FUTURE DIRECTIONS 🧚

None.

nothing coming. the future is quiet. πŸŽ€


πŸ‘‘ SEE ALSO πŸ‘‘

  • iswalnum()
  • iswalpha()
  • iswctype()
  • iswdigit()
  • iswgraph()
  • iswlower()
  • iswprint()
  • iswpunct()
  • iswspace()
  • iswupper()
  • iswxdigit()
  • setlocale()
  • uselocale()

also, the Base Definitions volume of POSIX.1‐2017, Chapter 7, Locale, plus <locale.h> and <wctype.h>. 🌸


portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. in the event of any discrepancy between this version 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 .

any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. to report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


okay that's the whole page, you ate it up πŸ“βœ¨ huge shoutout to IEEE/The Open Group, 2017, for bringing us ISWCNTRL(3POSIX) β€” go forth and classify your control wide-character codes responsibly, bestie πŸ’–πŸ¦‹