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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)atol.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/stdlib/atol.3,v 1.14 2007/01/09 00:28:09 imp Exp $
  34 .\" $DragonFly: src/lib/libc/stdlib/atol.3,v 1.3 2005/11/01 18:16:52 swildner Exp $
  35 .\"
  36 .Dd November 28, 2001
  37 .Dt ATOL 3
  38 .Os
  39 .Sh NAME
  40 .Nm atol ,
  41 .Nm atoll
  42 .Nd convert
  43 .Tn ASCII
  44 string to
  45 .Vt long
  46 or
  47 .Vt "long long"
  48 integer
  49 .Sh LIBRARY
  50 .Lb libc
  51 .Sh SYNOPSIS
  52 .In stdlib.h
  53 .Ft long
  54 .Fn atol "const char *nptr"
  55 .Ft "long long"
  56 .Fn atoll "const char *nptr"
  57 .Sh DESCRIPTION
  58 The
  59 .Fn atol
  60 function converts the initial portion of the string pointed to by
  61 .Fa nptr
  62 to
  63 .Vt long
  64 integer
  65 representation.
  66 .Pp
  67 It is equivalent to:
  68 .Pp
  69 .Dl "strtol(nptr, NULL, 10);"
  70 .Pp
  71 The
  72 .Fn atoll
  73 function converts the initial portion of the string pointed to by
  74 .Fa nptr
  75 to
  76 .Vt "long long"
  77 integer
  78 representation.
  79 .Pp
  80 It is equivalent to:
  81 .Pp
  82 .Dl "strtoll(nptr, NULL, 10);"
  83 .Sh ERRORS
  84 The functions
  85 .Fn atol
  86 and
  87 .Fn atoll
  88 need not
  89 affect the value of
  90 .Va errno
  91 on an error.
  92 .Sh SEE ALSO
  93 .Xr atof 3 ,
  94 .Xr atoi 3 ,
  95 .Xr strtod 3 ,
  96 .Xr strtol 3 ,
  97 .Xr strtoul 3
  98 .Sh STANDARDS
  99 The
 100 .Fn atol
 101 function
 102 conforms to
 103 .St -isoC .
 104 The
 105 .Fn atoll
 106 function
 107 conforms to
 108 .St -isoC-99 .