lib/libc/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$
  38 .\"
  39 .Dd November 28, 2001
  40 .Dt ATOL 3
  41 .Os
  42 .Sh NAME
  43 .Nm atol , atoll
  44 .Nd convert
  45 .Tn ASCII
  46 string to
  47 .Vt long
  48 or
  49 .Vt "long long"
  50 integer
  51 .Sh LIBRARY
  52 .Lb libc
  53 .Sh SYNOPSIS
  54 .In stdlib.h
  55 .Ft long
  56 .Fn atol "const char *nptr"
  57 .Ft "long long"
  58 .Fn atoll "const char *nptr"
  59 .Sh DESCRIPTION
  60 The
  61 .Fn atol
  62 function converts the initial portion of the string pointed to by
  63 .Fa nptr
  64 to
  65 .Vt long
  66 integer
  67 representation.
  68 .Pp
  69 It is equivalent to:
  70 .Pp
  71 .Dl "strtol(nptr, (char **)NULL, 10);"
  72 .Pp
  73 The
  74 .Fn atoll
  75 function converts the initial portion of the string pointed to by
  76 .Fa nptr
  77 to
  78 .Vt "long long"
  79 integer
  80 representation.
  81 .Pp
  82 It is equivalent to:
  83 .Pp
  84 .Dl "strtoll(nptr, (char **)NULL, 10);"
  85 .Sh ERRORS
  86 The functions
  87 .Fn atol
  88 and
  89 .Fn atoll
  90 need not
  91 affect the value of
  92 .Va errno
  93 on an error.
  94 .Sh SEE ALSO
  95 .Xr atof 3 ,
  96 .Xr atoi 3 ,
  97 .Xr strtod 3 ,
  98 .Xr strtol 3 ,
  99 .Xr strtoul 3
 100 .Sh STANDARDS
 101 The
 102 .Fn atol
 103 function
 104 conforms to
 105 .St -isoC .
 106 The
 107 .Fn atoll
 108 function
 109 conforms to
 110 .St -isoC-99 .