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
36 .Nm strtol , strtoll , strtoimax , strtoq
37 .Nd "convert a string value to a"
38 .Vt long , "long long" , intmax_t
48 .Fn strtol "const char * restrict nptr" "char ** restrict endptr" "int base"
50 .Fn strtoll "const char * restrict nptr" "char ** restrict endptr" "int base"
53 .Fn strtoimax "const char * restrict nptr" "char ** restrict endptr" "int base"
58 .Fn strtoq "const char *nptr" "char **endptr" "int base"
63 converts the string in
71 converts the string in
79 converts the string in
87 converts the string in
92 The conversion is done according to the given
94 which must be between 2 and 36 inclusive,
95 or be the special value 0.
97 The string may begin with an arbitrary amount of white space
100 followed by a single optional
108 the string may then include a
110 prefix, and the number will be read in base 2; or it may include a
113 and the number will be read in base 16; otherwise, a zero
115 is taken as 10 (decimal) unless the next character is
117 in which case it is taken as 8 (octal).
119 The remainder of the string is converted to a
120 .Vt long , "long long" , intmax_t
123 value in the obvious manner,
124 stopping at the first character which is not a valid digit
126 (In bases above 10, the letter
128 in either upper or lower case
131 represents 11, and so forth, with
140 stores the address of the first invalid character in
142 If there were no digits at all, however,
144 stores the original value of
156 on return, the entire string was valid.)
165 return the result of the conversion,
166 unless the value would underflow or overflow.
167 If no conversion could be performed, 0 is returned and
172 (the last feature is not portable across all platforms).
173 If an overflow or underflow occurs,
177 and the function return value is clamped according
178 to the following table.
179 .Bl -column -offset indent ".Fn strtoimax" ".Sy underflow" ".Sy overflow"
180 .It Sy Function Ta Sy underflow Ta Sy overflow
181 .It Fn strtol Ta Dv LONG_MIN Ta Dv LONG_MAX
182 .It Fn strtoll Ta Dv LLONG_MIN Ta Dv LLONG_MAX
183 .It Fn strtoimax Ta Dv INTMAX_MIN Ta Dv INTMAX_MAX
184 .It Fn strtoq Ta Dv LLONG_MIN Ta Dv LLONG_MAX
192 no conversion could be performed
193 (the last feature is not portable across all platforms).
195 The given string was out of range; the value converted has been clamped.
221 function is deprecated.