original/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  2014-02-10 "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 .sp
  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 .SS Multithreading (see pthreads(7))
  56 The
  57 .BR iswcntrl ()
  58 function is thread-safe with exceptions.
  59 It can be safely used in multithreaded applications, as long as
  60 .BR setlocale (3)
  61 is not called to change the locale during its execution.
  62 .SH CONFORMING TO
  63 C99.
  64 .SH NOTES
  65 The behavior of
  66 .BR iswcntrl ()
  67 depends on the
  68 .B LC_CTYPE
  69 category of the
  70 current locale.
  71 .SH SEE ALSO
  72 .BR iscntrl (3),
  73 .BR iswctype (3)
  74 .SH COLOPHON
  75 This page is part of release 3.67 of the Linux
  76 .I man-pages
  77 project.
  78 A description of the project,
  79 information about reporting bugs,
  80 and the latest version of this page,
  81 can be found at
  82 \%http://www.kernel.org/doc/man\-pages/.