xref: /freebsd/lib/libc/locale/iswalnum.3 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.\"
36.Dd October 3, 2002
37.Dt ISWALNUM 3
38.Os
39.Sh NAME
40.Nm iswalnum ,
41.Nm iswalpha ,
42.Nm iswascii ,
43.Nm iswblank ,
44.Nm iswcntrl ,
45.Nm iswdigit ,
46.Nm iswgraph ,
47.Nm iswhexnumber ,
48.Nm iswideogram ,
49.Nm iswlower ,
50.Nm iswnumber ,
51.Nm iswphonogram ,
52.Nm iswprint ,
53.Nm iswpunct ,
54.Nm iswrune ,
55.Nm iswspace ,
56.Nm iswspecial ,
57.Nm iswupper ,
58.Nm iswxdigit
59.Nd wide character classification utilities
60.Sh LIBRARY
61.Lb libc
62.Sh SYNOPSIS
63.In wctype.h
64.Ft int
65.Fn iswalnum "wint_t wc"
66.Ft int
67.Fn iswalpha "wint_t wc"
68.Ft int
69.Fn iswascii "wint_t wc"
70.Ft int
71.Fn iswblank "wint_t wc"
72.Ft int
73.Fn iswcntrl "wint_t wc"
74.Ft int
75.Fn iswdigit "wint_t wc"
76.Ft int
77.Fn iswgraph "wint_t wc"
78.Ft int
79.Fn iswhexnumber "wint_t wc"
80.Ft int
81.Fn iswideogram "wint_t wc"
82.Ft int
83.Fn iswlower "wint_t wc"
84.Ft int
85.Fn iswnumber "wint_t wc"
86.Ft int
87.Fn iswphonogram "wint_t wc"
88.Ft int
89.Fn iswprint "wint_t wc"
90.Ft int
91.Fn iswpunct "wint_t wc"
92.Ft int
93.Fn iswrune "wint_t wc"
94.Ft int
95.Fn iswspace "wint_t wc"
96.Ft int
97.Fn iswspecial "wint_t wc"
98.Ft int
99.Fn iswupper "wint_t wc"
100.Ft int
101.Fn iswxdigit "wint_t wc"
102.Sh DESCRIPTION
103The above functions are character classification utility functions,
104for use with wide characters
105.Vt ( wchar_t
106or
107.Vt wint_t ) .
108See the description for the similarly-named single byte classification
109functions (like
110.Xr isalnum 3 ) ,
111for details.
112.Sh RETURN VALUES
113The functions return zero if the character tests false and
114return non-zero if the character tests true.
115.Sh SEE ALSO
116.Xr isalnum 3 ,
117.Xr isalpha 3 ,
118.Xr isascii 3 ,
119.Xr isblank 3 ,
120.Xr iscntrl 3 ,
121.Xr isdigit 3 ,
122.Xr isgraph 3 ,
123.Xr ishexnumber 3 ,
124.Xr isideogram 3 ,
125.Xr islower 3 ,
126.Xr isnumber 3 ,
127.Xr isphonogram 3 ,
128.Xr isprint 3 ,
129.Xr ispunct 3 ,
130.Xr isrune 3 ,
131.Xr isspace 3 ,
132.Xr isspecial 3 ,
133.Xr isupper 3 ,
134.Xr isxdigit 3 ,
135.Xr wctype 3
136.Sh STANDARDS
137These functions conform to
138.St -p1003.1-2001 ,
139except
140.Fn iswascii ,
141.Fn iswhexnumber ,
142.Fn iswideogram ,
143.Fn iswnumber ,
144.Fn iswphonogram ,
145.Fn iswrune
146and
147.Fn iswspecial ,
148which are
149.Fx
150extensions.
151.Sh CAVEATS
152The result of these functions is undefined unless
153the argument is
154.Dv WEOF
155or a valid
156.Vt wchar_t
157value for the current locale.
158