[apple/libc.git] / locale / FreeBSD / digittoint.3

.\" Copyright (c) 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)digittoint.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/locale/digittoint.3,v 1.6 2009/09/04 07:44:58 des Exp $
.\"
.Dd April 6, 2001
.Dt DIGITTOINT 3
.Os
.Sh NAME
.Nm digittoint ,
.Nm digittoint_l
.Nd convert a numeric character to its integer value
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fo digittoint
.Fa "int c"
.Fc
.In xlocale.h
.In ctype.h
.Ft int
.Fo digittoint_l
.Fa "int c"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn digittoint
function converts a numeric character to its corresponding integer value.
The character can be any decimal digit or hexadecimal digit.
With hexadecimal characters, the case of the values does not matter.
.Pp
While the
.Fn digittoint
function uses the current locale, the
.Fn digittoint_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.Sh RETURN VALUES
The
.Fn digittoint
function always returns an integer from the range of 0 to 15.
If the given character was not a digit as defined by
.Xr isxdigit 3 ,
the function will return 0.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr isdigit 3 ,
.Xr isxdigit 3 ,
.Xr xlocale 3
Commit	Line	Data
5b2abdfb	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.
e9ce8d39 A	12	.\" 4. 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	.\"
9385eb3d	28	.\" @(#)digittoint.3 8.1 (Berkeley) 6/4/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/locale/digittoint.3,v 1.6 2009/09/04 07:44:58 des Exp $
e9ce8d39	30	.\"
9385eb3d A	31	.Dd April 6, 2001
9385eb3d A	32	.Dt DIGITTOINT 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
ad3c9f2a A	35	.Nm digittoint ,
ad3c9f2a A	36	.Nm digittoint_l
9385eb3d	37	.Nd convert a numeric character to its integer value
e9ce8d39 A	38	.Sh LIBRARY
	39	.Lb libc
	40	.Sh SYNOPSIS
5b2abdfb	41	.In ctype.h
e9ce8d39	42	.Ft int
ad3c9f2a A	43	.Fo digittoint
	44	.Fa "int c"
	45	.Fc
	46	.In xlocale.h
	47	.In ctype.h
	48	.Ft int
	49	.Fo digittoint_l
	50	.Fa "int c"
	51	.Fa "locale_t loc"
	52	.Fc
e9ce8d39 A	53	.Sh DESCRIPTION
e9ce8d39 A	54	The
9385eb3d A	55	.Fn digittoint
	56	function converts a numeric character to its corresponding integer value.
	57	The character can be any decimal digit or hexadecimal digit.
	58	With hexadecimal characters, the case of the values does not matter.
ad3c9f2a A	59	.Pp
	60	While the
	61	.Fn digittoint
	62	function uses the current locale, the
	63	.Fn digittoint_l
	64	function may be passed a locale directly. See
	65	.Xr xlocale 3
	66	for more information.
e9ce8d39	67	.Sh RETURN VALUES
e9ce8d39	68	The
9385eb3d A	69	.Fn digittoint
	70	function always returns an integer from the range of 0 to 15.
	71	If the given character was not a digit as defined by
	72	.Xr isxdigit 3 ,
	73	the function will return 0.
5b2abdfb	74	.Sh SEE ALSO
3d9156a7	75	.Xr ctype 3 ,
5b2abdfb	76	.Xr isdigit 3 ,
ad3c9f2a A	77	.Xr isxdigit 3 ,
ad3c9f2a A	78	.Xr xlocale 3