locale/FreeBSD/digittoint.3

   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 .\" 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 .\"
  28 .\"     @(#)digittoint.3        8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/locale/digittoint.3,v 1.6 2009/09/04 07:44:58 des Exp $
  30 .\"
  31 .Dd April 6, 2001
  32 .Dt DIGITTOINT 3
  33 .Os
  34 .Sh NAME
  35 .Nm digittoint ,
  36 .Nm digittoint_l
  37 .Nd convert a numeric character to its integer value
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In ctype.h
  42 .Ft int
  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
  53 .Sh DESCRIPTION
  54 The
  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.
  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.
  67 .Sh RETURN VALUES
  68 The
  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.
  74 .Sh SEE ALSO
  75 .Xr ctype 3 ,
  76 .Xr isdigit 3 ,
  77 .Xr isxdigit 3 ,
  78 .Xr xlocale 3