xref: /freebsd/lib/libc/locale/isxdigit.3 (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)isxdigit.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd July 17, 2005
36.Dt ISXDIGIT 3
37.Os
38.Sh NAME
39.Nm isxdigit, ishexnumber
40.Nd hexadecimal-digit character test
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In ctype.h
45.Ft int
46.Fn isxdigit "int c"
47.Ft int
48.Fn ishexnumber "int c"
49.Sh DESCRIPTION
50The
51.Fn isxdigit
52function tests for any hexadecimal-digit character.
53Regardless of locale, this includes the following characters only:
54.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
55.It "\&``0''" Ta "``1''" Ta "``2''" Ta "``3''" Ta "``4''"
56.It "\&``5''" Ta "``6''" Ta "``7''" Ta "``8''" Ta "``9''"
57.It "\&``A''" Ta "``B''" Ta "``C''" Ta "``D''" Ta "``E''"
58.It "\&``F''" Ta "``a''" Ta "``b''" Ta "``c''" Ta "``d''"
59.It "\&``e''" Ta "``f''" Ta \& Ta \& Ta \&
60.El
61.Pp
62The
63.Fn ishexnumber
64function behaves similarly to
65.Fn isxdigit ,
66but may recognize additional characters,
67depending on the current locale setting.
68.Pp
69The value of the argument must be representable as an
70.Vt "unsigned char"
71or the value of
72.Dv EOF .
73.Sh RETURN VALUES
74The
75.Fn isxdigit
76function returns zero if the character tests false and
77returns non-zero if the character tests true.
78.Sh COMPATIBILITY
79The
80.Bx 4.4
81extension of accepting arguments outside of the range of the
82.Vt "unsigned char"
83type in locales with large character sets is considered obsolete
84and may not be supported in future releases.
85The
86.Fn iswxdigit
87function should be used instead.
88.Sh SEE ALSO
89.Xr ctype 3 ,
90.Xr iswxdigit 3 ,
91.Xr ascii 7
92.Sh STANDARDS
93The
94.Fn isxdigit
95function conforms to
96.St -isoC .
97.Sh HISTORY
98The
99.Fn ishexnumber
100function appeared in
101.Bx 4.4 .
102