man3/iswcntrl.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH ISWCNTRL 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 iswcntrl \- test for control wide character
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wctype.h>
  22 .PP
  23 .BI "int iswcntrl(wint_t " wc );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR iswcntrl ()
  28 function is the wide-character equivalent of the
  29 .BR iscntrl (3)
  30 function.
  31 It tests whether
  32 .I wc
  33 is a wide character
  34 belonging to the wide-character class "cntrl".
  35 .PP
  36 The wide-character class "cntrl" is disjoint from the wide-character class
  37 "print" and therefore also disjoint from its subclasses "graph", "alpha",
  38 "upper", "lower", "digit", "xdigit", "punct".
  39 .PP
  40 For an unsigned char
  41 .IR c ,
  42 .I iscntrl(c)
  43 implies
  44 .IR iswcntrl(btowc(c)) ,
  45 but not vice versa.
  46 .SH RETURN VALUE
  47 The
  48 .BR iswcntrl ()
  49 function returns nonzero if
  50 .I wc
  51 is a
  52 wide character belonging to the wide-character class "cntrl".
  53 Otherwise, it returns zero.
  54 .SH ATTRIBUTES
  55 For an explanation of the terms used in this section, see
  56 .BR attributes (7).
  57 .ad l
  58 .nh
  59 .TS
  60 allbox;
  61 lbx lb lb
  62 l l l.
  63 Interface       Attribute       Value
  64 T{
  65 .BR iswcntrl ()
  66 T}      Thread safety   MT-Safe locale
  67 .TE
  68 .hy
  69 .ad
  70 .sp 1
  71 .SH CONFORMING TO
  72 POSIX.1-2001, POSIX.1-2008, C99.
  73 .SH NOTES
  74 The behavior of
  75 .BR iswcntrl ()
  76 depends on the
  77 .B LC_CTYPE
  78 category of the
  79 current locale.
  80 .SH SEE ALSO
  81 .BR iscntrl (3),
  82 .BR iswctype (3)