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. 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.
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
32 .\" @(#)strtol.3 8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/stdlib/strtol.3,v 1.23 2007/04/10 11:17:00 ru Exp $
46 .Nd "convert a string value to a"
47 .Vt long , "long long" , intmax_t
57 .Fn strtol "const char * restrict nptr" "char ** restrict endptr" "int base"
59 .Fn strtoll "const char * restrict nptr" "char ** restrict endptr" "int base"
62 .Fn strtoimax "const char * restrict nptr" "char ** restrict endptr" "int base"
65 .Fn strtoq "const char *nptr" "char **endptr" "int base"
68 .Fn strtol_l "const char * restrict nptr" "char ** restrict endptr" "int base" "locale_t locale"
70 .Fn strtoll_l "const char * restrict nptr" "char ** restrict endptr" "int base" "locale_t locale"
72 .Fn strtoimax_l "const char * restrict nptr" "char ** restrict endptr" "int base" "locale_t locale"
78 functions convert the string in
87 functions convert the string in
96 functions convert the string in
104 converts the string in
109 The conversion is done according to the given
111 which must be between 2 and 36 inclusive,
112 or be the special value 0.
114 The string may begin with an arbitrary amount of white space
119 followed by a single optional
127 the string may then include a
130 and the number will be read in base 16; otherwise, a zero
132 is taken as 10 (decimal) unless the next character is
134 in which case it is taken as 8 (octal).
136 The remainder of the string is converted to a
137 .Vt long , "long long" , intmax_t
140 value in the obvious manner,
141 stopping at the first character which is not a valid digit
143 (In bases above 10, the letter
145 in either upper or lower case
148 represents 11, and so forth, with
159 store the address of the first invalid character in
161 If there were no digits at all, however,
165 store the original value of
177 on return, the entire string was valid.)
184 functions take an explicit
186 argument, whereas the
192 functions use the current global or per-thread locale.
204 return the result of the conversion,
205 unless the value would underflow or overflow.
206 If no conversion could be performed, 0 is returned and
211 (the last feature is not portable across all platforms).
212 If an overflow or underflow occurs,
216 and the function return value is clamped according
217 to the following table.
218 .Bl -column -offset indent ".Fn strtoimax_l" ".Sy underflow" ".Sy overflow"
219 .It Sy Function Ta Sy underflow Ta Sy overflow
220 .It Fn strtol Ta Dv LONG_MIN Ta Dv LONG_MAX
221 .It Fn strtol_l Ta Dv LONG_MIN Ta Dv LONG_MAX
222 .It Fn strtoll Ta Dv LLONG_MIN Ta Dv LLONG_MAX
223 .It Fn strtoll_l Ta Dv LLONG_MIN Ta Dv LLONG_MAX
224 .It Fn strtoimax Ta Dv INTMAX_MIN Ta Dv INTMAX_MAX
225 .It Fn strtoimax_l Ta Dv INTMAX_MIN Ta Dv INTMAX_MAX
226 .It Fn strtoq Ta Dv LLONG_MIN Ta Dv LLONG_MAX
234 no conversion could be performed
235 (the last feature is not portable across all platforms).
237 The given string was out of range; the value converted has been clamped.
264 -function is deprecated.