Blame man-pages-posix-2013-a/man3p/iswcntrl.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH ISWCNTRL "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
iswcntrl,
Packit 7cfc04
iswcntrl_l
Packit 7cfc04
\(em test for a control wide-character code
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <wctype.h>
Packit 7cfc04
.P
Packit 7cfc04
int iswcntrl(wint_t \fIwc\fP);
Packit 7cfc04
int iswcntrl_l(wint_t \fIwc\fP, locale_t \fIlocale\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
For
Packit 7cfc04
\fIiswcntrl\fR():
Packit 7cfc04
The functionality described on this reference page is aligned with the
Packit 7cfc04
ISO\ C standard. Any conflict between the requirements described here and the
Packit 7cfc04
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
\fIiswcntrl\fR()
Packit 7cfc04
and
Packit 7cfc04
\fIiswcntrl_l\fR()
Packit 7cfc04
functions shall test whether
Packit 7cfc04
.IR wc
Packit 7cfc04
is a wide-character code representing a character of class
Packit 7cfc04
.BR cntrl
Packit 7cfc04
in the current locale,
Packit 7cfc04
or in the locale represented by
Packit 7cfc04
.IR locale ,
Packit 7cfc04
respectively; see the Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Chapter 7" ", " "Locale".
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.IR wc
Packit 7cfc04
argument is a
Packit 7cfc04
.BR wint_t ,
Packit 7cfc04
the value of which the application shall ensure is a wide-character
Packit 7cfc04
code corresponding to a valid character in the current locale, or equal
Packit 7cfc04
to the value of the macro WEOF. If the argument has any other value,
Packit 7cfc04
the behavior is undefined.
Packit 7cfc04
.P
Packit 7cfc04
The behavior is undefined if the
Packit 7cfc04
.IR locale
Packit 7cfc04
argument to
Packit 7cfc04
\fIiswcntrl_l\fR()
Packit 7cfc04
is the special locale object LC_GLOBAL_LOCALE or is not a valid locale
Packit 7cfc04
object handle.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
The
Packit 7cfc04
\fIiswcntrl\fR()
Packit 7cfc04
and
Packit 7cfc04
\fIiswcntrl_l\fR()
Packit 7cfc04
functions shall return non-zero if
Packit 7cfc04
.IR wc
Packit 7cfc04
is a control wide-character code; otherwise, they shall return 0.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
No errors are defined.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
To ensure applications portability, especially across natural
Packit 7cfc04
languages, only these functions and the functions in the reference pages
Packit 7cfc04
listed in the SEE ALSO section should be used for character classification.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
None.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIiswalnum\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswalpha\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswctype\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswdigit\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswgraph\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswlower\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswprint\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswpunct\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswspace\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswupper\fR\^(\|)",
Packit 7cfc04
.IR "\fIiswxdigit\fR\^(\|)",
Packit 7cfc04
.IR "\fIsetlocale\fR\^(\|)",
Packit 7cfc04
.IR "\fIuselocale\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Chapter 7" ", " "Locale",
Packit 7cfc04
.IR "\fB<locale.h>\fP",
Packit 7cfc04
.IR "\fB<wctype.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .