xref: /freebsd/lib/libc/stdlib/atol.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.\"
34.Dd May 14, 2013
35.Dt ATOL 3
36.Os
37.Sh NAME
38.Nm atol , atoll
39.Nd convert
40.Tn ASCII
41string to
42.Vt long
43or
44.Vt "long long"
45integer
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In stdlib.h
50.Ft long
51.Fn atol "const char *nptr"
52.Ft "long long"
53.Fn atoll "const char *nptr"
54.Sh DESCRIPTION
55The
56.Fn atol
57function converts the initial portion of the string pointed to by
58.Fa nptr
59to
60.Vt long
61integer
62representation.
63.Pp
64It is equivalent to:
65.Pp
66.Dl "strtol(nptr, (char **)NULL, 10);"
67.Pp
68The
69.Fn atoll
70function converts the initial portion of the string pointed to by
71.Fa nptr
72to
73.Vt "long long"
74integer
75representation.
76.Pp
77It is equivalent to:
78.Pp
79.Dl "strtoll(nptr, (char **)NULL, 10);"
80.Sh COMPATIBILITY
81The
82.Fx
83implementations of the
84.Fn atol
85and
86.Fn atoll
87functions are thin wrappers around
88.Fn strtol
89and
90.Fn strtoll
91respectively, so these functions will affect the value of
92.Va errno
93in the same way that the
94.Fn strtol
95and
96.Fn strtoll
97functions are able to.
98This behavior of
99.Fn atol
100and
101.Fn atoll
102is not required by
103.St -isoC
104or
105.St -isoC-99 ,
106but it is allowed by all of
107.St -isoC , St -isoC-99
108and
109.St -p1003.1-2001 .
110.Sh ERRORS
111The functions
112.Fn atol
113and
114.Fn atoll
115may affect the value of
116.Va errno
117on an error.
118.Sh SEE ALSO
119.Xr atof 3 ,
120.Xr atoi 3 ,
121.Xr strtod 3 ,
122.Xr strtol 3 ,
123.Xr strtoul 3
124.Sh STANDARDS
125The
126.Fn atol
127function
128conforms to
129.St -isoC .
130The
131.Fn atoll
132function
133conforms to
134.St -isoC-99 .
135