sync

[thirdparty/man-pages.git] / man3 / wctype.3

.\" 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 WCTYPE 3  1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
wctype \- wide character classification
.SH SYNOPSIS
.nf
.B #include <wctype.h>
.sp
.BI "wctype_t wctype(const char *" name );
.fi
.SH DESCRIPTION
The \fBwctype_t\fP type represents a property which a wide character may or
may not have. In other words, it represents a class of wide characters.
This type's nature is implementation dependent, but the special value
\fI(wctype_t)0\fP denotes an invalid property. Nonzero \fBwctype_t\fP values
can be passed to the \fBiswctype\fP() function to actually test whether a given
wide character has the property.
.PP
The \fBwctype\fP() function returns a property, given by its name. The set of
valid names depends on the LC_CTYPE category of the current locale, but the
following names are valid in all locales.
.nf
  "alnum" \- realizes the \fBisalnum\fP() classification function
  "alpha" \- realizes the \fBisalpha\fP() classification function
  "blank" \- realizes the \fBisblank\fP() classification function
  "cntrl" \- realizes the \fBiscntrl\fP() classification function
  "digit" \- realizes the \fBisdigit\fP() classification function
  "graph" \- realizes the \fBisgraph\fP() classification function
  "lower" \- realizes the \fBislower\fP() classification function
  "print" \- realizes the \fBisprint\fP() classification function
  "punct" \- realizes the \fBispunct\fP() classification function
  "space" \- realizes the \fBisspace\fP() classification function
  "upper" \- realizes the \fBisupper\fP() classification function
  "xdigit" \- realizes the \fBisxdigit\fP() classification function
.fi
.SH "RETURN VALUE"
The \fBwctype\fP() function returns a property descriptor if the \fIname\fP is
valid. Otherwise it returns \fI(wctype_t)0\fP.
.SH "CONFORMING TO"
C99.
.SH "SEE ALSO"
.BR iswctype (3)
.SH NOTES
The behaviour of \fBwctype\fP() depends on the LC_CTYPE category of the
current locale.