xref: /freebsd/lib/libc/locale/iswalnum.3 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1.\"	$NetBSD: iswalnum.3,v 1.5 2002/07/10 14:46:10 yamt Exp $
2.\"
3.\" Copyright (c) 1991 The Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the American National Standards Committee X3, on Information
8.\" Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)isalnum.3	5.2 (Berkeley) 6/29/91
35.\" $FreeBSD$
36.\"
37.Dd October 3, 2002
38.Dt ISWALNUM 3
39.Os
40.Sh NAME
41.Nm iswalnum ,
42.Nm iswalpha ,
43.Nm iswascii ,
44.Nm iswblank ,
45.Nm iswcntrl ,
46.Nm iswdigit ,
47.Nm iswgraph ,
48.Nm iswhexnumber ,
49.Nm iswideogram ,
50.Nm iswlower ,
51.Nm iswnumber ,
52.Nm iswphonogram ,
53.Nm iswprint ,
54.Nm iswpunct ,
55.Nm iswrune ,
56.Nm iswspace ,
57.Nm iswspecial ,
58.Nm iswupper ,
59.Nm iswxdigit
60.Nd wide character classification utilities
61.Sh LIBRARY
62.Lb libc
63.Sh SYNOPSIS
64.In wctype.h
65.Ft int
66.Fn iswalnum "wint_t wc"
67.Ft int
68.Fn iswalpha "wint_t wc"
69.Ft int
70.Fn iswascii "wint_t wc"
71.Ft int
72.Fn iswblank "wint_t wc"
73.Ft int
74.Fn iswcntrl "wint_t wc"
75.Ft int
76.Fn iswdigit "wint_t wc"
77.Ft int
78.Fn iswgraph "wint_t wc"
79.Ft int
80.Fn iswhexnumber "wint_t wc"
81.Ft int
82.Fn iswideogram "wint_t wc"
83.Ft int
84.Fn iswlower "wint_t wc"
85.Ft int
86.Fn iswnumber "wint_t wc"
87.Ft int
88.Fn iswphonogram "wint_t wc"
89.Ft int
90.Fn iswprint "wint_t wc"
91.Ft int
92.Fn iswpunct "wint_t wc"
93.Ft int
94.Fn iswrune "wint_t wc"
95.Ft int
96.Fn iswspace "wint_t wc"
97.Ft int
98.Fn iswspecial "wint_t wc"
99.Ft int
100.Fn iswupper "wint_t wc"
101.Ft int
102.Fn iswxdigit "wint_t wc"
103.Sh DESCRIPTION
104The above functions are character classification utility functions,
105for use with wide characters
106.Vt ( wchar_t
107or
108.Vt wint_t ) .
109See the description for the similarly-named single byte classification
110functions (like
111.Xr isalnum 3 ) ,
112for details.
113.Sh RETURN VALUES
114The functions return zero if the character tests false and
115return non-zero if the character tests true.
116.Sh SEE ALSO
117.Xr isalnum 3 ,
118.Xr isalpha 3 ,
119.Xr isascii 3 ,
120.Xr isblank 3 ,
121.Xr iscntrl 3 ,
122.Xr isdigit 3 ,
123.Xr isgraph 3 ,
124.Xr ishexnumber 3 ,
125.Xr isideogram 3 ,
126.Xr islower 3 ,
127.Xr isnumber 3 ,
128.Xr isphonogram 3 ,
129.Xr isprint 3 ,
130.Xr ispunct 3 ,
131.Xr isrune 3 ,
132.Xr isspace 3 ,
133.Xr isspecial 3 ,
134.Xr isupper 3 ,
135.Xr isxdigit 3 ,
136.Xr wctype 3
137.Sh STANDARDS
138These functions conform to
139.St -p1003.1-2001 ,
140except
141.Fn iswascii ,
142.Fn iswhexnumber ,
143.Fn iswideogram ,
144.Fn iswnumber ,
145.Fn iswphonogram ,
146.Fn iswrune
147and
148.Fn iswspecial ,
149which are
150.Fx
151extensions.
152.Sh CAVEATS
153The result of these functions is undefined unless
154the argument is
155.Dv WEOF
156or a valid
157.Vt wchar_t
158value for the current locale.
159