man-pages/man3/iswcntrl.3

57 lines
1.6 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" Dinkumware C library reference http://www.dinkumware.com/
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
.\" ISO/IEC 9899:1999
.\"
.TH ISWCNTRL 3 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
iswcntrl \- test for control wide character
.SH SYNOPSIS
.nf
.B #include <wctype.h>
.sp
.BI "int iswcntrl(wint_t " wc );
.fi
.SH DESCRIPTION
The
.BR iswcntrl ()
function is the wide-character equivalent of the
.BR iscntrl (3)
function.
It tests whether \fIwc\fP is a wide character
belonging to the wide-character class "cntrl".
2004-11-03 13:51:07 +00:00
.PP
The wide-character class "cntrl" is disjoint from the wide-character class
2004-11-03 13:51:07 +00:00
"print" and therefore also disjoint from its subclasses "graph", "alpha",
"upper", "lower", "digit", "xdigit", "punct".
.PP
2007-04-24 19:06:06 +00:00
For an unsigned char \fIc\fP, \fIiscntrl(c)\fP
implies \fIiswcntrl(btowc(c))\fP,
2004-11-03 13:51:07 +00:00
but not vice versa.
.SH "RETURN VALUE"
The
.BR iswcntrl ()
2008-03-19 13:16:39 +00:00
function returns non-zero if \fIwc\fP is a
wide character belonging to the wide-character class "cntrl".
Otherwise it returns zero.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
2006-08-03 13:57:30 +00:00
C99.
2004-11-03 13:51:07 +00:00
.SH NOTES
The behavior of
.BR iswcntrl ()
2007-06-22 18:25:23 +00:00
depends on the
.B LC_CTYPE
category of the
2004-11-03 13:51:07 +00:00
current locale.
2007-05-16 18:25:50 +00:00
.SH "SEE ALSO"
.BR iscntrl (3),
.BR iswctype (3)