]> git.saurik.com Git - apple/libc.git/blame_incremental - locale/FreeBSD/isxdigit.3
Libc-498.tar.gz
[apple/libc.git] / locale / FreeBSD / isxdigit.3
... / ...
CommitLineData
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.\" @(#)isxdigit.3 8.1 (Berkeley) 6/4/93
37.\" $FreeBSD: src/lib/libc/locale/isxdigit.3,v 1.20 2004/08/21 07:37:08 tjr Exp $
38.\"
39.Dd August 21, 2004
40.Dt ISXDIGIT 3
41.Os
42.Sh NAME
43.Nm isxdigit, ishexnumber
44.Nd hexadecimal-digit character test
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In ctype.h
49.Ft int
50.Fn isxdigit "int c"
51.Ft int
52.Fn ishexnumber "int c"
53.Sh DESCRIPTION
54The
55.Fn isxdigit
56function tests for any hexadecimal-digit character.
57Regardless of locale, this includes the following characters only:
58.Pp
59.Bl -column \&``0''______ \&``0''______ \&``0''______ \&``0''______ \&``0''______
60.It "\&``0''\t``1''\t``2''\t``3''\t``4''"
61.It "\&``5''\t``6''\t``7''\t``8''\t``9''"
62.It "\&``A''\t``B''\t``C''\t``D''\t``E''"
63.It "\&``F''\t``a''\t``b''\t``c''\t``d''"
64.It "\&``e''\t``f''"
65.El
66.Pp
67The
68.Fn ishexnumber
69function behaves similarly to
70.Fn isxdigit ,
71but may recognize additional characters,
72depending on the current locale setting.
73.Pp
74For single C
75.Va char Ns s
76locales (see
77.Xr multibyte 3 )
78the value of the argument is
79representable as an
80.Li unsigned char
81or the value of
82.Dv EOF .
83.Sh RETURN VALUES
84The
85.Fn isxdigit
86function returns zero if the character tests false and
87returns non-zero if the character tests true.
88.Sh COMPATIBILITY
89The
90.Bx 4.4
91extension of accepting arguments outside of the range of the
92.Vt "unsigned char"
93type in locales with large character sets is considered obsolete
94and may not be supported in future releases.
95The
96.Fn iswxdigit
97function should be used instead.
98.Sh SEE ALSO
99.Xr ctype 3 ,
100.Xr iswxdigit 3 ,
101.Xr multibyte 3 ,
102.Xr ascii 7
103.Sh STANDARDS
104The
105.Fn isxdigit
106function conforms to
107.St -isoC .
108.Sh HISTORY
109The
110.Fn ishexnumber
111function appeared in
112.Bx 4.4 .