xref: /openbsd/lib/libc/locale/iswctype.3 (revision 898184e3)
1.\" $OpenBSD: iswctype.3,v 1.2 2007/05/31 19:19:29 jmc Exp $
2.\" $NetBSD: iswctype.3,v 1.5 2003/04/16 13:34:40 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: May 31 2007 $
29.Dt ISWCTYPE 3
30.Os
31.\" ----------------------------------------------------------------------
32.Sh NAME
33.Nm iswctype
34.Nd test a character for character class identifier
35.\" ----------------------------------------------------------------------
36.Sh SYNOPSIS
37.Fd #include <wctype.h>
38.Ft int
39.Fn iswctype "wint_t wc" "wctype_t charclass"
40.\" ----------------------------------------------------------------------
41.Sh DESCRIPTION
42The
43.Fn iswctype
44function returns a boolean value that indicates whether a wide character
45.Fa wc
46is in
47.Fa charclass .
48.Pp
49The behaviour of the
50.Fn iswctype
51is undefined if the
52.Fn iswctype
53function is called with an invalid
54.Fa charclass
55(changes of
56.Dv LC_CTYPE
57category invalidate
58.Fa charclass )
59or invalid wide character
60.Fa wc .
61.Pp
62The behaviour of the
63.Fn iswctype
64is affected by the
65.Dv LC_CTYPE
66category of the current locale.
67.\" ----------------------------------------------------------------------
68.Sh RETURN VALUES
69The
70.Fn iswcttype
71returns:
72.Bl -tag -width 012345678901
73.It 0
74.Fa wc
75is not in
76.Fa charclass .
77.It non-zero
78.Fa wc
79is in
80.Fa charclass .
81.El
82.Pp
83.\" ----------------------------------------------------------------------
84.Sh ERRORS
85No errors are defined.
86.\" ----------------------------------------------------------------------
87.Sh SEE ALSO
88.Xr setlocale 3 ,
89.Xr towctrans 3 ,
90.Xr wctrans 3 ,
91.Xr wctype 3
92.\" ----------------------------------------------------------------------
93.Sh STANDARDS
94The
95.Fn iswctype
96function conforms to
97.\" .St -isoC-amd1 .
98ISO/IEC 9899/AMD1:1995
99.Pq Dq ISO C90, Amendment 1 .
100