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