Debian Codegraph @

upstream/debian-trixie/man3/iswcntrl.3

raw
1 '\" t
2 .\" Copyright (c) Bruno Haible <[email protected]>
3 .\"
4 .\" SPDX-License-Identifier: GPL-2.0-or-later
5 .\"
6 .\" References consulted:
7 .\" GNU glibc-2 source code and manual
8 .\" Dinkumware C library reference http://www.dinkumware.com/
9 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
10 .\" ISO/IEC 9899:1999
11 .\"
12 .TH iswcntrl 3 2024-05-02 "Linux man-pages 6.9.1"
13 .SH NAME
14 iswcntrl \- test for control wide character
15 .SH LIBRARY
16 Standard C library
17 .RI ( libc ", " \-lc )
18 .SH SYNOPSIS
19 .nf
20 .B #include <wctype.h>
21 .P
22 .BI "int iswcntrl(wint_t " wc );
23 .fi
24 .SH DESCRIPTION
25 The
26 .BR iswcntrl ()
27 function is the wide-character equivalent of the
28 .BR iscntrl (3)
29 function.
30 It tests whether
31 .I wc
32 is a wide character
33 belonging to the wide-character class "cntrl".
34 .P
35 The wide-character class "cntrl" is disjoint from the wide-character class
36 "print" and therefore also disjoint from its subclasses "graph", "alpha",
37 "upper", "lower", "digit", "xdigit", "punct".
38 .P
39 For an unsigned char
40 .IR c ,
41 .I iscntrl(c)
42 implies
43 .IR iswcntrl(btowc(c)) ,
44 but not vice versa.
45 .SH RETURN VALUE
46 The
47 .BR iswcntrl ()
48 function returns nonzero if
49 .I wc
50 is a
51 wide character belonging to the wide-character class "cntrl".
52 Otherwise, it returns zero.
53 .SH ATTRIBUTES
54 For an explanation of the terms used in this section, see
55 .BR attributes (7).
56 .TS
57 allbox;
58 lbx lb lb
59 l l l.
60 Interface Attribute Value
61 T{
62 .na
63 .nh
64 .BR iswcntrl ()
65 T} Thread safety MT-Safe locale
66 .TE
67 .SH STANDARDS
68 C11, POSIX.1-2008.
69 .SH HISTORY
70 POSIX.1-2001, C99.
71 .SH NOTES
72 The behavior of
73 .BR iswcntrl ()
74 depends on the
75 .B LC_CTYPE
76 category of the
77 current locale.
78 .SH SEE ALSO
79 .BR iscntrl (3),
80 .BR iswctype (3)