1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" References consulted:
24 .\" Linux libc source code
25 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
27 .\" Modified Sun Jul 25 10:53:39 1993 by Rik Faith (faith@cs.unc.edu)
28 .\" Added correction due to nsd@bbc.com (Nick Duffek) - aeb, 950610
29 .TH STRTOL 3 2013-02-10 "GNU" "Linux Programmer's Manual"
31 strtol, strtoll, strtoq \- convert a string to a long integer
34 .B #include <stdlib.h>
36 .BI "long int strtol(const char *" nptr ", char **" endptr ", int " base );
38 .BI "long long int strtoll(const char *" nptr ", char **" endptr \
43 Feature Test Macro Requirements for glibc (see
44 .BR feature_test_macros (7)):
50 XOPEN_SOURCE\ >=\ 600 || _BSD_SOURCE || _SVID_SOURCE || _ISOC99_SOURCE ||
51 _POSIX_C_SOURCE\ >=\ 200112L;
60 function converts the initial part of the string
61 in \fInptr\fP to a long integer value according to the given \fIbase\fP,
62 which must be between 2 and 36 inclusive, or be the special value 0.
64 The string may begin with an arbitrary amount of white space (as
67 followed by a single optional \(aq+\(aq or \(aq\-\(aq sign.
68 If \fIbase\fP is zero or 16, the string may then include a
69 "0x" prefix, and the number will be read in base 16; otherwise, a
70 zero \fIbase\fP is taken as 10 (decimal) unless the next character
71 is \(aq0\(aq, in which case it is taken as 8 (octal).
73 The remainder of the string is converted to a
76 in the obvious manner, stopping at the first character which is not a
77 valid digit in the given base.
78 (In bases above 10, the letter \(aqA\(aq in
79 either upper or lower case represents 10, \(aqB\(aq represents 11, and so
80 forth, with \(aqZ\(aq representing 35.)
82 If \fIendptr\fP is not NULL,
84 stores the address of the
85 first invalid character in \fI*endptr\fP.
86 If there were no digits at
89 stores the original value of \fInptr\fP in
90 \fI*endptr\fP (and returns 0).
91 In particular, if \fI*nptr\fP is not \(aq\\0\(aq but \fI**endptr\fP
92 is \(aq\\0\(aq on return, the entire string is valid.
96 function works just like the
98 function but returns a long long integer value.
102 function returns the result of the conversion,
103 unless the value would underflow or overflow.
104 If an underflow occurs,
108 If an overflow occurs,
112 In both cases, \fIerrno\fP is set to
114 Precisely the same holds for
130 contains an unsupported value.
133 The resulting value was out of range.
135 The implementation may also set \fIerrno\fP to \fBEINVAL\fP in case
136 no conversion was performed (no digits seen, and 0 returned).
139 conforms to SVr4, 4.3BSD, C89, C99 and POSIX.1-2001, and
141 to C99 and POSIX.1-2001.
145 can legitimately return 0,
154 on both success and failure, the calling program should set
156 to 0 before the call,
157 and then determine if an error occurred by checking whether
159 has a nonzero value after the call.
161 According to POSIX.1-2001,
162 in locales other than the "C" and "POSIX",
163 these functions may accept other,
164 implementation-defined numeric strings.
166 other implementation-defined strings may be accepted.
167 (For example, the thousands separator of the current locale may be
174 .BI "quad_t strtoq(const char *" nptr ", char **" endptr ", int " base );
178 with completely analogous definition.
179 Depending on the wordsize of the current architecture, this
185 The program shown below demonstrates the use of
187 The first command-line argument specifies a string from which
189 should parse a number.
190 The second (optional) argument specifies the base to be used for
192 (This argument is converted to numeric form using
194 a function that performs no error checking and
195 has a simpler interface than
197 Some examples of the results produced by this program are the following:
201 .RB "$" " ./a.out 123"
202 strtol() returned 123
203 .RB "$" " ./a.out \(aq 123\(aq"
204 strtol() returned 123
205 .RB "$" " ./a.out 123abc"
206 strtol() returned 123
207 Further characters after number: abc
208 .RB "$" " ./a.out 123abc 55"
209 strtol: Invalid argument
210 .RB "$" " ./a.out \(aq\(aq"
212 .RB "$" " ./a.out 4000000000"
213 strtol: Numerical result out of range
225 main(int argc, char *argv[])
232 fprintf(stderr, "Usage: %s str [base]\\n", argv[0]);
237 base = (argc > 2) ? atoi(argv[2]) : 10;
239 errno = 0; /* To distinguish success/failure after call */
240 val = strtol(str, &endptr, base);
242 /* Check for various possible errors */
244 if ((errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
245 || (errno != 0 && val == 0)) {
251 fprintf(stderr, "No digits were found\\n");
255 /* If we got here, strtol() successfully parsed a number */
257 printf("strtol() returned %ld\\n", val);
259 if (*endptr != \(aq\\0\(aq) /* Not necessarily an error... */
260 printf("Further characters after number: %s\\n", endptr);