]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/iswcntrl.3
user_namespaces.7: Minor rewordings of recently added text
[thirdparty/man-pages.git] / man3 / iswcntrl.3
CommitLineData
fea681da
MK
1.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2.\"
89e3ffe9 3.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
fea681da
MK
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.
fe382ebf 8.\" %%%LICENSE_END
fea681da
MK
9.\"
10.\" References consulted:
11.\" GNU glibc-2 source code and manual
12.\" Dinkumware C library reference http://www.dinkumware.com/
008f1ecc 13.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
fea681da
MK
14.\" ISO/IEC 9899:1999
15.\"
460495ca 16.TH ISWCNTRL 3 2015-08-08 "GNU" "Linux Programmer's Manual"
fea681da
MK
17.SH NAME
18iswcntrl \- test for control wide character
19.SH SYNOPSIS
20.nf
21.B #include <wctype.h>
68e4db0a 22.PP
fea681da
MK
23.BI "int iswcntrl(wint_t " wc );
24.fi
25.SH DESCRIPTION
60a90ecd
MK
26The
27.BR iswcntrl ()
28function is the wide-character equivalent of the
29.BR iscntrl (3)
30function.
35cfd378
MK
31It tests whether
32.I wc
33is a wide character
d0f17b57 34belonging to the wide-character class "cntrl".
fea681da 35.PP
d0f17b57 36The wide-character class "cntrl" is disjoint from the wide-character class
fea681da
MK
37"print" and therefore also disjoint from its subclasses "graph", "alpha",
38"upper", "lower", "digit", "xdigit", "punct".
39.PP
35cfd378
MK
40For an unsigned char
41.IR c ,
42.I iscntrl(c)
43implies
44.IR iswcntrl(btowc(c)) ,
fea681da 45but not vice versa.
47297adb 46.SH RETURN VALUE
60a90ecd
MK
47The
48.BR iswcntrl ()
35cfd378
MK
49function returns nonzero if
50.I wc
51is a
d0f17b57 52wide character belonging to the wide-character class "cntrl".
2b9b829d 53Otherwise, it returns zero.
65126e61 54.SH ATTRIBUTES
249564d0
MK
55For an explanation of the terms used in this section, see
56.BR attributes (7).
57.TS
58allbox;
59lb lb lb
60l l l.
61Interface Attribute Value
62T{
65126e61 63.BR iswcntrl ()
249564d0
MK
64T} Thread safety MT-Safe locale
65.TE
47297adb 66.SH CONFORMING TO
d8ca300f 67POSIX.1-2001, POSIX.1-2008, C99.
fea681da 68.SH NOTES
d9bfdb9c 69The behavior of
60a90ecd 70.BR iswcntrl ()
1274071a
MK
71depends on the
72.B LC_CTYPE
73category of the
fea681da 74current locale.
47297adb 75.SH SEE ALSO
e37e3282
MK
76.BR iscntrl (3),
77.BR iswctype (3)