xref: /openbsd/lib/libc/locale/wctype.3 (revision 91f110e0)
1.\" $OpenBSD: wctype.3,v 1.3 2013/06/05 03:39:22 tedu Exp $
2.\" $NetBSD: wctype.3,v 1.4 2003/04/16 13:34:41 wiz Exp $
3.\"
4.\" Copyright (c)2003 Citrus Project,
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd $Mdocdate: June 5 2013 $
29.Dt WCTYPE 3
30.Os
31.\" ----------------------------------------------------------------------
32.Sh NAME
33.Nm wctype
34.Nd get character class identifier by name
35.\" ----------------------------------------------------------------------
36.Sh SYNOPSIS
37.In wctype.h
38.Ft wctype_t
39.Fn wctype "const char *charclass"
40.\" ----------------------------------------------------------------------
41.Sh DESCRIPTION
42The
43.Fn wctype
44function returns a character class identifier corresponding to the
45locale-specific character class name
46.Fa charclass .
47This identifier can be used in subsequent calls of
48.Fn iswctype .
49The following names are defined in all locales:
50.Bd -literal -offset indent
51alnum alpha blank cntrl digit graph
52lower print punct space upper xdigit
53.Ed
54.Pp
55The behaviour of
56.Fn wctype
57is affected by the
58.Dv LC_CTYPE
59category of the current locale.
60.\" ----------------------------------------------------------------------
61.Sh RETURN VALUES
62.Fn wcttype
63returns:
64.Bl -tag -width 012345678901
65.It 0
66If
67.Fa charclass
68does not correspond to a valid character class name.
69.It non-zero
70A character class identifier corresponding to
71.Fa charclass .
72.El
73.Pp
74Note: wctype_t is a scalar type, e.g., a pointer.
75.\" ----------------------------------------------------------------------
76.Sh ERRORS
77No errors are defined.
78.\" ----------------------------------------------------------------------
79.Sh SEE ALSO
80.Xr iswctype 3 ,
81.Xr setlocale 3 ,
82.Xr towctrans 3 ,
83.Xr wctrans 3
84.\" ----------------------------------------------------------------------
85.Sh STANDARDS
86The
87.Fn wctype
88function conforms to
89.\" .St -isoC-amd1 .
90ISO/IEC 9899/AMD1:1995
91.Pq Sq ISO C90, Amendment 1 .
92