lib/libcr/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.3.2.3 2001/12/14 18:33:58 ru Exp $
  38 .\" $DragonFly: src/lib/libcr/stdlib/Attic/atol.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt ATOL 3
  42 .Os
  43 .Sh NAME
  44 .Nm atol
  45 .Nd convert
  46 .Tn ASCII
  47 string to long integer
  48 .Sh LIBRARY
  49 .Lb libc
  50 .Sh SYNOPSIS
  51 .In stdlib.h
  52 .Ft long
  53 .Fn atol "const char *nptr"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn atol
  57 function converts the initial portion of the string pointed to by
  58 .Ar nptr
  59 to
  60 .Em long integer
  61 representation.
  62 .Pp
  63 It is equivalent to:
  64 .Bd -literal -offset indent
  65 strtol(nptr, (char **)NULL, 10);
  66 .Ed
  67 .Sh SEE ALSO
  68 .Xr atof 3 ,
  69 .Xr atoi 3 ,
  70 .Xr strtod 3 ,
  71 .Xr strtol 3 ,
  72 .Xr strtoul 3
  73 .Sh STANDARDS
  74 The
  75 .Fn atol
  76 function
  77 conforms to
  78 .St -isoC .