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