man3/iswcntrl.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH ISWCNTRL 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 iswcntrl \- test for control wide character
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wctype.h>
  20 .sp
  21 .BI "int iswcntrl(wint_t " wc );
  22 .fi
  23 .SH DESCRIPTION
  24 The
  25 .BR iswcntrl ()
  26 function is the wide-character equivalent of the
  27 .BR iscntrl (3)
  28 function.
  29 It tests whether \fIwc\fP is a wide character
  30 belonging to the wide-character class "cntrl".
  31 .PP
  32 The wide-character class "cntrl" is disjoint from the wide-character class
  33 "print" and therefore also disjoint from its subclasses "graph", "alpha",
  34 "upper", "lower", "digit", "xdigit", "punct".
  35 .PP
  36 For an unsigned char \fIc\fP, \fIiscntrl(c)\fP
  37 implies \fIiswcntrl(btowc(c))\fP,
  38 but not vice versa.
  39 .SH "RETURN VALUE"
  40 The
  41 .BR iswcntrl ()
  42 function returns nonzero if \fIwc\fP is a
  43 wide character belonging to the wide-character class "cntrl".
  44 Otherwise it returns zero.
  45 .SH "CONFORMING TO"
  46 C99.
  47 .SH NOTES
  48 The behavior of
  49 .BR iswcntrl ()
  50 depends on the
  51 .B LC_CTYPE
  52 category of the
  53 current locale.
  54 .SH "SEE ALSO"
  55 .BR iscntrl (3),
  56 .BR iswctype (3)