xref: /netbsd-src/lib/libc/locale/iswctype.3 (revision 080f488178b79ee1e602e35cd270630080defd1d)
1.\" $NetBSD: iswctype.3,v 1.7 2007/05/21 15:20:40 tnozaki Exp $
2.\"
3.\" Copyright (c)2003 Citrus Project,
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd March 4, 2003
28.Dt ISWCTYPE 3
29.Os
30.\" ----------------------------------------------------------------------
31.Sh NAME
32.Nm iswctype
33.Nd test a character for character class identifier
34.\" ----------------------------------------------------------------------
35.Sh LIBRARY
36.Lb libc
37.\" ----------------------------------------------------------------------
38.Sh SYNOPSIS
39.In wctype.h
40.Ft int
41.Fn iswctype "wint_t wc" "wctype_t charclass"
42.\" ----------------------------------------------------------------------
43.Sh DESCRIPTION
44The
45.Fn iswctype
46function returns a boolean value that indicates whether a wide character
47.Fa wc
48is in
49.Fa charclass .
50.Pp
51The behaviour of
52.Fn iswctype
53is undefined if the
54.Fn iswctype
55function is called with an invalid
56.Fa charclass
57(changes of
58.Dv LC_CTYPE
59category invalidate
60.Fa charclass )
61or invalid wide character
62.Fa wc .
63.Pp
64The behaviour of
65.Fn iswctype
66is affected by the
67.Dv LC_CTYPE
68category of the current locale.
69.\" ----------------------------------------------------------------------
70.Sh RETURN VALUES
71The
72.Fn iswctype
73returns:
74.Bl -tag -width 012345678901
75.It 0
76.Fa wc
77is not in
78.Fa charclass .
79.It non-zero
80.Fa wc
81is in
82.Fa charclass .
83.El
84.Pp
85.\" ----------------------------------------------------------------------
86.Sh ERRORS
87No errors are defined.
88.\" ----------------------------------------------------------------------
89.Sh SEE ALSO
90.Xr setlocale 3 ,
91.Xr towctrans 3 ,
92.Xr wctrans 3 ,
93.Xr wctype 3
94.\" ----------------------------------------------------------------------
95.Sh STANDARDS
96The
97.Fn iswctype
98function conforms to
99.St -isoC-amd1 .
100