stdlib/atol.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)atol.3      8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/stdlib/atol.3,v 1.13 2002/01/09 14:03:54 ru Exp $
  38 .\"
  39 .Dd November 28, 2001
  40 .Dt ATOL 3
  41 .Os
  42 .Sh NAME
  43 .Nm atol , atoll ,
  44 .Nm atol_l , atoll_l
  45 .Nd convert
  46 .Tn ASCII
  47 string to
  48 .Vt long
  49 or
  50 .Vt "long long"
  51 integer
  52 .Sh LIBRARY
  53 .Lb libc
  54 .Sh SYNOPSIS
  55 .In stdlib.h
  56 .Ft long
  57 .Fn atol "const char *str"
  58 .Ft "long long"
  59 .Fn atoll "const char *str"
  60 .In xlocale.h
  61 .Ft long
  62 .Fn atol_l "const char *str" "locale_t loc"
  63 .Ft "long long"
  64 .Fn atoll_l "const char *str" "locale_t loc"
  65 .Sh DESCRIPTION
  66 The
  67 .Fn atol
  68 function converts the initial portion of the string pointed to by
  69 .Fa str
  70 to
  71 .Vt long
  72 integer
  73 representation.
  74 .Pp
  75 It is equivalent to:
  76 .Pp
  77 .Dl "strtol(str, (char **)NULL, 10);"
  78 .Pp
  79 The
  80 .Fn atoll
  81 function converts the initial portion of the string pointed to by
  82 .Fa str
  83 to
  84 .Vt "long long"
  85 integer
  86 representation.
  87 .Pp
  88 It is equivalent to:
  89 .Pp
  90 .Dl "strtoll(str, (char **)NULL, 10);"
  91 .Pp
  92 While the
  93 .Fn atol
  94 and
  95 .Fn atoll
  96 functions use the current locale, the
  97 .Fn atol_l
  98 and
  99 .Fn atoll_l
 100 functions may be passed locales directly. See
 101 .Xr xlocale 3
 102 for more information.
 103 .Sh ERRORS
 104 The functions
 105 .Fn atol
 106 and
 107 .Fn atoll
 108 need not
 109 affect the value of
 110 .Va errno
 111 on an error.
 112 .Sh SEE ALSO
 113 .Xr atof 3 ,
 114 .Xr atoi 3 ,
 115 .Xr strtod 3 ,
 116 .Xr strtol 3 ,
 117 .Xr strtoul 3 ,
 118 .Xr xlocale 3
 119 .Sh STANDARDS
 120 The
 121 .Fn atol
 122 function
 123 conforms to
 124 .St -isoC .
 125 The
 126 .Fn atoll
 127 function
 128 conforms to
 129 .St -isoC-99 .