1 .\" Copyright (c) 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek and the American National Standards Committee X3,
6 .\" on Information Processing Systems.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
36 .\" @(#)strtol.3 8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libc/stdlib/strtol.3,v 1.21 2006/05/20 21:11:35 maxim Exp $
38 .\" $DragonFly: src/lib/libc/stdlib/strtol.3,v 1.5 2007/04/10 21:09:00 swildner Exp $
44 .Nm strtol , strtoll , strtoimax , strtoq
45 .Nd "convert a string value to a"
46 .Vt long , "long long" , intmax_t
56 .Fn strtol "const char *nptr" "char **endptr" "int base"
58 .Fn strtoll "const char *nptr" "char **endptr" "int base"
61 .Fn strtoimax "const char *nptr" "char **endptr" "int base"
66 .Fn strtoq "const char *nptr" "char **endptr" "int base"
71 converts the string in
79 converts the string in
87 converts the string in
95 converts the string in
100 The conversion is done according to the given
102 which must be between 2 and 36 inclusive,
103 or be the special value 0.
105 The string may begin with an arbitrary amount of white space
108 followed by a single optional
116 the string may then include a
119 and the number will be read in base 16; otherwise, a zero
121 is taken as 10 (decimal) unless the next character is
123 in which case it is taken as 8 (octal).
125 The remainder of the string is converted to a
126 .Vt long , "long long" , intmax_t
129 value in the obvious manner,
130 stopping at the first character which is not a valid digit
132 (In bases above 10, the letter
134 in either upper or lower case
137 represents 11, and so forth, with
146 stores the address of the first invalid character in
148 If there were no digits at all, however,
150 stores the original value of
162 on return, the entire string was valid.)
171 return the result of the conversion,
172 unless the value would underflow or overflow.
173 If no conversion could be performed, 0 is returned and
178 (the last feature is not portable across all platforms).
179 If an overflow or underflow occurs,
183 and the function return value is clamped according
184 to the following table.
185 .Bl -column -offset indent ".Fn strtoimax" ".Sy underflow" ".Sy overflow"
186 .It Sy Function Ta Sy underflow Ta Sy overflow
187 .It Fn strtol Ta Dv LONG_MIN Ta Dv LONG_MAX
188 .It Fn strtoll Ta Dv LLONG_MIN Ta Dv LLONG_MAX
189 .It Fn strtoimax Ta Dv INTMAX_MIN Ta Dv INTMAX_MAX
190 .It Fn strtoq Ta Dv LLONG_MIN Ta Dv LLONG_MAX
198 no conversion could be performed
199 (the last feature is not portable across all platforms).
201 The given string was out of range; the value converted has been clamped.
227 function is deprecated.