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