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  1999-07-25 "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 \fIwc\fP is a wide character
  32 belonging to the wide-character class "cntrl".
  33 .PP
  34 The wide-character class "cntrl" is disjoint from the wide-character class
  35 "print" and therefore also disjoint from its subclasses "graph", "alpha",
  36 "upper", "lower", "digit", "xdigit", "punct".
  37 .PP
  38 For an unsigned char \fIc\fP, \fIiscntrl(c)\fP
  39 implies \fIiswcntrl(btowc(c))\fP,
  40 but not vice versa.
  41 .SH RETURN VALUE
  42 The
  43 .BR iswcntrl ()
  44 function returns nonzero if \fIwc\fP is a
  45 wide character belonging to the wide-character class "cntrl".
  46 Otherwise it returns zero.
  47 .SH CONFORMING TO
  48 C99.
  49 .SH NOTES
  50 The behavior of
  51 .BR iswcntrl ()
  52 depends on the
  53 .B LC_CTYPE
  54 category of the
  55 current locale.
  56 .SH SEE ALSO
  57 .BR iscntrl (3),
  58 .BR iswctype (3)