xref: /freebsd/lib/libc/locale/digittoint.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 1993
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)digittoint.3	8.1 (Berkeley) 6/4/93
29.\"
30.Dd December 19, 2022
31.Dt DIGITTOINT 3
32.Os
33.Sh NAME
34.Nm digittoint ,
35.Nm digittoint_l
36.Nd convert a numeric character to its integer value
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In ctype.h
41.Ft int
42.Fn digittoint "int c"
43.Ft int
44.Fn digittoint_l "int c" "locale_t loc"
45.Sh DESCRIPTION
46The
47.Fn digittoint
48and
49.Fn digittoint_l
50functions convert a numeric character to its corresponding integer value.
51The character can be any decimal digit or hexadecimal digit.
52With hexadecimal characters, the case of the values does not matter.
53.Pp
54The
55.Fn digittoint_l
56function takes an explicit locale argument, whereas the
57.Fn digittoint
58function use the current global or per-thread locale.
59.Sh RETURN VALUES
60The
61.Fn digittoint
62and
63.Fn digittoint_l
64functions always return an integer from the range of 0 to 15.
65If the given character was not a digit as defined by
66.Xr isxdigit 3
67or
68.Xr isxdigit_l 3 ,
69the function will return 0.
70.Sh SEE ALSO
71.Xr ctype 3 ,
72.Xr ctype_l 3 ,
73.Xr isdigit 3 ,
74.Xr isdigit_l 3 ,
75.Xr isxdigit 3 ,
76.Xr isxdigit_l 3 ,
77.Xr xlocale 3
78