xref: /freebsd/lib/libc/locale/isalnum.3 (revision 3047fefe49f57a673de8df152c199de12ec2c6d3)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)isalnum.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd October 6, 2002
40.Dt ISALNUM 3
41.Os
42.Sh NAME
43.Nm isalnum
44.Nd alphanumeric character test
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In ctype.h
49.Ft int
50.Fn isalnum "int c"
51.Sh DESCRIPTION
52The
53.Fn isalnum
54function tests for any character for which
55.Xr isalpha 3
56or
57.Xr isdigit 3
58is true.
59For single C
60.Va char Ns s
61locales (see
62.Xr multibyte 3 )
63the value of the argument is
64representable as an
65.Li unsigned char
66or the value of
67.Dv EOF .
68In the ASCII character set, this includes the following characters
69(with their numeric values shown in octal):
70.Pp
71.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
72.It "\&060\ ``0'' \t061\ ``1'' \t062\ ``2'' \t063\ ``3'' \t064\ ``4''"
73.It "\&065\ ``5'' \t066\ ``6'' \t067\ ``7'' \t070\ ``8'' \t071\ ``9''"
74.It "\&101\ ``A'' \t102\ ``B'' \t103\ ``C'' \t104\ ``D'' \t105\ ``E''"
75.It "\&106\ ``F'' \t107\ ``G'' \t110\ ``H'' \t111\ ``I'' \t112\ ``J''"
76.It "\&113\ ``K'' \t114\ ``L'' \t115\ ``M'' \t116\ ``N'' \t117\ ``O''"
77.It "\&120\ ``P'' \t121\ ``Q'' \t122\ ``R'' \t123\ ``S'' \t124\ ``T''"
78.It "\&125\ ``U'' \t126\ ``V'' \t127\ ``W'' \t130\ ``X'' \t131\ ``Y''"
79.It "\&132\ ``Z'' \t141\ ``a'' \t142\ ``b'' \t143\ ``c'' \t144\ ``d''"
80.It "\&145\ ``e'' \t146\ ``f'' \t147\ ``g'' \t150\ ``h'' \t151\ ``i''"
81.It "\&152\ ``j'' \t153\ ``k'' \t154\ ``l'' \t155\ ``m'' \t156\ ``n''"
82.It "\&157\ ``o'' \t160\ ``p'' \t161\ ``q'' \t162\ ``r'' \t163\ ``s''"
83.It "\&164\ ``t'' \t165\ ``u'' \t166\ ``v'' \t167\ ``w'' \t170\ ``x''"
84.It "\&171\ ``y'' \t172\ ``z''"
85.El
86.Sh RETURN VALUES
87The
88.Fn isalnum
89function returns zero if the character tests false and
90returns non-zero if the character tests true.
91.Sh COMPATIBILITY
92Although
93.Fn isalnum
94accepts arguments outside of the range of the
95.Vt "unsigned char"
96type in locales with large character sets,
97this is a
98.Bx 4.4
99extension and the
100.Fn iswalnum
101function should be used instead for maximum portability.
102.Sh SEE ALSO
103.Xr ctype 3 ,
104.Xr isalpha 3 ,
105.Xr isdigit 3 ,
106.Xr iswalnum 3 ,
107.Xr multibyte 3 ,
108.Xr ascii 7
109.Sh STANDARDS
110The
111.Fn isalnum
112function conforms to
113.St -isoC .
114