]> git.saurik.com Git - apple/libc.git/blame - locale/digittoint.3
Libc-583.tar.gz
[apple/libc.git] / locale / digittoint.3
CommitLineData
224c7076 1.\" Copyright (c) 1993
e9ce8d39
A
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. 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.\"
224c7076
A
32.\" @(#)digittoint.3 8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/locale/digittoint.3,v 1.3 2004/03/30 07:19:35 tjr Exp $
e9ce8d39 34.\"
224c7076
A
35.Dd April 6, 2001
36.Dt DIGITTOINT 3
e9ce8d39
A
37.Os
38.Sh NAME
224c7076
A
39.Nm digittoint ,
40.Nm digittoint_l
41.Nd convert a numeric character to its integer value
e9ce8d39
A
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
224c7076
A
45.In ctype.h
46.Ft int
47.Fo digittoint
48.Fa "int c"
49.Fc
50.In xlocale.h
51.In ctype.h
52.Ft int
53.Fo digittoint_l
54.Fa "int c"
55.Fa "locale_t loc"
56.Fc
e9ce8d39
A
57.Sh DESCRIPTION
58The
224c7076
A
59.Fn digittoint
60function converts a numeric character to its corresponding integer value.
61The character can be any decimal digit or hexadecimal digit.
62With hexadecimal characters, the case of the values does not matter.
63.Pp
64While the
65.Fn digittoint
66function uses the current locale, the
67.Fn digittoint_l
68function may be passed a locale directly. See
69.Xr xlocale 3
70for more information.
e9ce8d39 71.Sh RETURN VALUES
5b2abdfb 72The
224c7076
A
73.Fn digittoint
74function always returns an integer from the range of 0 to 15.
75If the given character was not a digit as defined by
76.Xr isxdigit 3 ,
77the function will return 0.
78.Sh SEE ALSO
79.Xr ctype 3 ,
80.Xr isdigit 3 ,
81.Xr isxdigit 3 ,
82.Xr xlocale 3