]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/wctype.3
81eeba800b9277c5fd8d037ee47b49c579873a45
[thirdparty/man-pages.git] / man3 / wctype.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" References consulted:
9 .\" GNU glibc-2 source code and manual
10 .\" Dinkumware C library reference http://www.dinkumware.com/
11 .\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
12 .\" ISO/IEC 9899:1999
13 .\"
14 .TH WCTYPE 3 1999-07-25 "GNU" "Linux Programmer's Manual"
15 .SH NAME
16 wctype \- wide character classification
17 .SH SYNOPSIS
18 .nf
19 .B #include <wctype.h>
20 .sp
21 .BI "wctype_t wctype(const char *" name );
22 .fi
23 .SH DESCRIPTION
24 The \fBwctype_t\fP type represents a property which a wide character may or
25 may not have. In other words, it represents a class of wide characters.
26 This type's nature is implementation dependent, but the special value
27 \fI(wctype_t)0\fP denotes an invalid property. Nonzero \fBwctype_t\fP values
28 can be passed to the \fBiswctype\fP function to actually test whether a given
29 wide character has the property.
30 .PP
31 The \fBwctype\fP function returns a property, given by its name. The set of
32 valid names depends on the LC_CTYPE category of the current locale, but the
33 following names are valid in all locales.
34 .nf
35 "alnum" \- realizes the \fBisalnum\fP classification function
36 "alpha" \- realizes the \fBisalpha\fP classification function
37 "blank" \- realizes the \fBisblank\fP classification function
38 "cntrl" \- realizes the \fBiscntrl\fP classification function
39 "digit" \- realizes the \fBisdigit\fP classification function
40 "graph" \- realizes the \fBisgraph\fP classification function
41 "lower" \- realizes the \fBislower\fP classification function
42 "print" \- realizes the \fBisprint\fP classification function
43 "punct" \- realizes the \fBispunct\fP classification function
44 "space" \- realizes the \fBisspace\fP classification function
45 "upper" \- realizes the \fBisupper\fP classification function
46 "xdigit" \- realizes the \fBisxdigit\fP classification function
47 .fi
48 .SH "RETURN VALUE"
49 The \fBwctype\fP function returns a property descriptor if the \fIname\fP is
50 valid. Otherwise it returns \fI(wctype_t)0\fP.
51 .SH "CONFORMING TO"
52 ISO/ANSI C, UNIX98
53 .SH "SEE ALSO"
54 .BR iswctype (3)
55 .SH NOTES
56 The behaviour of \fBwctype\fP depends on the LC_CTYPE category of the
57 current locale.