1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" References consulted:
26 .\" Linux libc source code
27 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
29 .\" Modified Sun Jul 25 10:53:39 1993 by Rik Faith (faith@cs.unc.edu)
30 .\" Added correction due to nsd@bbc.com (Nick Duffek) - aeb, 950610
31 .TH STRTOL 3 2014-03-18 "GNU" "Linux Programmer's Manual"
33 strtol, strtoll, strtoq \- convert a string to a long integer
36 .B #include <stdlib.h>
38 .BI "long int strtol(const char *" nptr ", char **" endptr ", int " base );
40 .BI "long long int strtoll(const char *" nptr ", char **" endptr \
45 Feature Test Macro Requirements for glibc (see
46 .BR feature_test_macros (7)):
52 _XOPEN_SOURCE\ >=\ 600 || _BSD_SOURCE || _SVID_SOURCE || _ISOC99_SOURCE ||
53 _POSIX_C_SOURCE\ >=\ 200112L;
62 function converts the initial part of the string
65 to a long integer value according to the given
67 which must be between 2 and 36 inclusive, or be the special value 0.
69 The string may begin with an arbitrary amount of white space (as
72 followed by a single optional \(aq+\(aq or \(aq\-\(aq sign.
75 is zero or 16, the string may then include a
76 "0x" prefix, and the number will be read in base 16; otherwise, a
79 is taken as 10 (decimal) unless the next character
80 is \(aq0\(aq, in which case it is taken as 8 (octal).
82 The remainder of the string is converted to a
85 in the obvious manner, stopping at the first character which is not a
86 valid digit in the given base.
87 (In bases above 10, the letter \(aqA\(aq in
88 either uppercase or lowercase represents 10, \(aqB\(aq represents 11, and so
89 forth, with \(aqZ\(aq representing 35.)
95 stores the address of the
96 first invalid character in
98 If there were no digits at
101 stores the original value of
108 is not \(aq\\0\(aq but
110 is \(aq\\0\(aq on return, the entire string is valid.
114 function works just like the
116 function but returns a long long integer value.
120 function returns the result of the conversion,
121 unless the value would underflow or overflow.
122 If an underflow occurs,
126 If an overflow occurs,
134 Precisely the same holds for
150 contains an unsupported value.
153 The resulting value was out of range.
155 The implementation may also set
160 no conversion was performed (no digits seen, and 0 returned).
162 .SS Multithreading (see pthreads(7))
168 functions are thread-safe with exceptions.
169 These functions can be safely used in multithreaded applications,
172 is not called to change the locale during their execution.
175 conforms to SVr4, 4.3BSD, C89, C99, and POSIX.1-2001, and
177 to C99 and POSIX.1-2001.
181 can legitimately return 0,
190 on both success and failure, the calling program should set
192 to 0 before the call,
193 and then determine if an error occurred by checking whether
195 has a nonzero value after the call.
197 According to POSIX.1-2001,
198 in locales other than the "C" and "POSIX",
199 these functions may accept other,
200 implementation-defined numeric strings.
206 .BI "quad_t strtoq(const char *" nptr ", char **" endptr ", int " base );
210 with completely analogous definition.
211 Depending on the wordsize of the current architecture, this
217 The program shown below demonstrates the use of
219 The first command-line argument specifies a string from which
221 should parse a number.
222 The second (optional) argument specifies the base to be used for
224 (This argument is converted to numeric form using
226 a function that performs no error checking and
227 has a simpler interface than
229 Some examples of the results produced by this program are the following:
233 .RB "$" " ./a.out 123"
234 strtol() returned 123
235 .RB "$" " ./a.out \(aq 123\(aq"
236 strtol() returned 123
237 .RB "$" " ./a.out 123abc"
238 strtol() returned 123
239 Further characters after number: abc
240 .RB "$" " ./a.out 123abc 55"
241 strtol: Invalid argument
242 .RB "$" " ./a.out \(aq\(aq"
244 .RB "$" " ./a.out 4000000000"
245 strtol: Numerical result out of range
257 main(int argc, char *argv[])
264 fprintf(stderr, "Usage: %s str [base]\\n", argv[0]);
269 base = (argc > 2) ? atoi(argv[2]) : 10;
271 errno = 0; /* To distinguish success/failure after call */
272 val = strtol(str, &endptr, base);
274 /* Check for various possible errors */
276 if ((errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
277 || (errno != 0 && val == 0)) {
283 fprintf(stderr, "No digits were found\\n");
287 /* If we got here, strtol() successfully parsed a number */
289 printf("strtol() returned %ld\\n", val);
291 if (*endptr != \(aq\\0\(aq) /* Not necessarily an error... */
292 printf("Further characters after number: %s\\n", endptr);