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