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 \fBiswcntrl\fP function is the wide-character equivalent of the
  25 \fBiscntrl\fP function. It tests whether \fIwc\fP is a wide character
  26 belonging to the wide character class "cntrl".
  27 .PP
  28 The wide character class "cntrl" is disjoint from the wide character class
  29 "print" and therefore also disjoint from its subclasses "graph", "alpha",
  30 "upper", "lower", "digit", "xdigit", "punct".
  31 .PP
  32 For an unsigned char \fIc\fP, \fIiscntrl(c)\fP implies \fIiswcntrl(btowc(c))\fP,
  33 but not vice versa.
  34 .SH "RETURN VALUE"
  35 The \fBiswcntrl\fP function returns non-zero if \fIwc\fP is a wide character
  36 belonging to the wide character class "cntrl". Otherwise it returns zero.
  37 .SH "CONFORMING TO"
  38 ISO/ANSI C, UNIX98
  39 .SH "SEE ALSO"
  40 .BR iscntrl (3),
  41 .BR iswctype (3)
  42 .SH NOTES
  43 The behaviour of \fBiswcntrl\fP depends on the LC_CTYPE category of the
  44 current locale.