1STRTOL(P)                  POSIX Programmer's Manual                 STRTOL(P)
2
3
4

NAME

6       strtol, strtoll - convert a string to a long integer
7

SYNOPSIS

9       #include <stdlib.h>
10
11       long  strtol(const  char  *restrict  str,  char  **restrict endptr, int
12       base);
13       long long strtoll(const char *restrict str, char **restrict endptr,
14              int base)
15
16

DESCRIPTION

18       These functions shall convert the initial portion of the string pointed
19       to  by  str  to a type long and long long representation, respectively.
20       First, they decompose the input string into three parts:
21
22        1. An initial, possibly empty, sequence of white-space characters  (as
23           specified by isspace())
24
25        2. A  subject  sequence  interpreted as an integer represented in some
26           radix determined by the value of base
27
28        3. A final string of one or more  unrecognized  characters,  including
29           the terminating null byte of the input string.
30
31       Then  they shall attempt to convert the subject sequence to an integer,
32       and return the result.
33
34       If the value of base is 0, the expected form of the subject sequence is
35       that  of  a  decimal constant, octal constant, or hexadecimal constant,
36       any of which may be preceded by a '+' or '-' sign. A  decimal  constant
37       begins  with  a  non-zero  digit, and consists of a sequence of decimal
38       digits. An octal constant consists of the prefix  '0'  optionally  fol‐
39       lowed  by a sequence of the digits '0' to '7' only.  A hexadecimal con‐
40       stant consists of the prefix 0x or 0X followed by  a  sequence  of  the
41       decimal  digits  and letters 'a' (or 'A' ) to 'f' (or 'F' ) with values
42       10 to 15 respectively.
43
44       If the value of base is between 2 and 36, the expected form of the sub‐
45       ject sequence is a sequence of letters and digits representing an inte‐
46       ger with the radix specified by base, optionally preceded by a  '+'  or
47       '-' sign. The letters from 'a' (or 'A' ) to 'z' (or 'Z' ) inclusive are
48       ascribed the values 10 to 35; only letters whose  ascribed  values  are
49       less  than  that of base are permitted. If the value of base is 16, the
50       characters 0x or 0X may optionally precede the sequence of letters  and
51       digits, following the sign if present.
52
53       The  subject  sequence is defined as the longest initial subsequence of
54       the input string, starting with  the  first  non-white-space  character
55       that  is  of  the  expected form. The subject sequence shall contain no
56       characters if the input string is empty or consists entirely of  white-
57       space  characters,  or  if the first non-white-space character is other
58       than a sign or a permissible letter or digit.
59
60       If the subject sequence has the expected form and the value of base  is
61       0,  the  sequence  of characters starting with the first digit shall be
62       interpreted as an integer constant. If the  subject  sequence  has  the
63       expected  form  and  the value of base is between 2 and 36, it shall be
64       used as the base for conversion, ascribing to each letter its value  as
65       given  above.  If  the  subject  sequence begins with a minus sign, the
66       value resulting from the conversion shall be negated. A pointer to  the
67       final  string  shall be stored in the object pointed to by endptr, pro‐
68       vided that endptr is not a null pointer.
69
70       In other than the C    or POSIX  locales, other  implementation-defined
71       subject sequences may be accepted.
72
73       If the subject sequence is empty or does not have the expected form, no
74       conversion is performed; the value of  str  is  stored  in  the  object
75       pointed to by endptr, provided that endptr is not a null pointer.
76
77       The strtol() function shall not change the setting of errno if success‐
78       ful.
79
80       Since 0, {LONG_MIN} or {LLONG_MIN}, and {LONG_MAX} or  {LLONG_MAX}  are
81       returned on error and are also valid returns on success, an application
82       wishing to check for error situations should set errno to 0, then  call
83       strtol() or strtoll(), then check errno.
84

RETURN VALUE

86       Upon  successful completion, these functions shall return the converted
87       value, if any. If no conversion could be performed, 0 shall be returned
88        and errno may be set to [EINVAL].
89
90       If  the  correct  value  is  outside the range of representable values,
91       {LONG_MIN}, {LONG_MAX}, {LLONG_MIN}, or {LLONG_MAX} shall  be  returned
92       (according to the sign of the value), and errno set to [ERANGE].
93

ERRORS

95       These functions shall fail if:
96
97       ERANGE The value to be returned is not representable.
98
99
100       These functions may fail if:
101
102       EINVAL The value of base is not supported.
103
104
105       The following sections are informative.
106

EXAMPLES

108       None.
109

APPLICATION USAGE

111       None.
112

RATIONALE

114       None.
115

FUTURE DIRECTIONS

117       None.
118

SEE ALSO

120       isalpha()  ,  scanf()  ,  strtod()  ,  the  Base  Definitions volume of
121       IEEE Std 1003.1-2001, <stdlib.h>
122
124       Portions of this text are reprinted and reproduced in  electronic  form
125       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
126       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
127       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
128       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
129       event of any discrepancy between this version and the original IEEE and
130       The Open Group Standard, the original IEEE and The Open Group  Standard
131       is  the  referee document. The original Standard can be obtained online
132       at http://www.opengroup.org/unix/online.html .
133
134
135
136IEEE/The Open Group                  2003                            STRTOL(P)
Impressum