xref: /freebsd/lib/libc/locale/digittoint.3 (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
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.Dd December 19, 2022
29.Dt DIGITTOINT 3
30.Os
31.Sh NAME
32.Nm digittoint ,
33.Nm digittoint_l
34.Nd convert a numeric character to its integer value
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In ctype.h
39.Ft int
40.Fn digittoint "int c"
41.Ft int
42.Fn digittoint_l "int c" "locale_t loc"
43.Sh DESCRIPTION
44The
45.Fn digittoint
46and
47.Fn digittoint_l
48functions convert a numeric character to its corresponding integer value.
49The character can be any decimal digit or hexadecimal digit.
50With hexadecimal characters, the case of the values does not matter.
51.Pp
52The
53.Fn digittoint_l
54function takes an explicit locale argument, whereas the
55.Fn digittoint
56function use the current global or per-thread locale.
57.Sh RETURN VALUES
58The
59.Fn digittoint
60and
61.Fn digittoint_l
62functions always return an integer from the range of 0 to 15.
63If the given character was not a digit as defined by
64.Xr isxdigit 3
65or
66.Xr isxdigit_l 3 ,
67the function will return 0.
68.Sh SEE ALSO
69.Xr ctype 3 ,
70.Xr ctype_l 3 ,
71.Xr isdigit 3 ,
72.Xr isdigit_l 3 ,
73.Xr isxdigit 3 ,
74.Xr isxdigit_l 3 ,
75.Xr xlocale 3
76