original/man3/strtol.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   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.
   6 .\"
   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.
  11 .\"
  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
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  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  2010-09-20 "GNU" "Linux Programmer's Manual"
  30 .SH NAME
  31 strtol, strtoll, strtoq \- convert a string to a long integer
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <stdlib.h>
  35 .sp
  36 .BI "long int strtol(const char *" nptr ", char **" endptr ", int " base );
  37 .sp
  38 .BI "long long int strtoll(const char *" nptr ", char **" endptr \
  39 ", int " base );
  40 .fi
  41 .sp
  42 .in -4n
  43 Feature Test Macro Requirements for glibc (see
  44 .BR feature_test_macros (7)):
  45 .in
  46 .sp
  47 .ad l
  48 .BR strtoll ():
  49 .RS 4
  50 XOPEN_SOURCE\ >=\ 600 || _BSD_SOURCE || _SVID_SOURCE || _ISOC99_SOURCE ||
  51 _POSIX_C_SOURCE\ >=\ 200112L;
  52 .br
  53 or
  54 .I cc\ -std=c99
  55 .RE
  56 .ad
  57 .SH DESCRIPTION
  58 The
  59 .BR strtol ()
  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.
  63 .PP
  64 The string may begin with an arbitrary amount of white space (as
  65 determined by
  66 .BR isspace (3))
  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).
  72 .PP
  73 The remainder of the string is converted to a
  74 .I long int
  75 value
  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.)
  81 .PP
  82 If \fIendptr\fP is not NULL,
  83 .BR strtol ()
  84 stores the address of the
  85 first invalid character in \fI*endptr\fP.
  86 If there were no digits at
  87 all,
  88 .BR strtol ()
  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.
  93 .PP
  94 The
  95 .BR strtoll ()
  96 function works just like the
  97 .BR strtol ()
  98 function but returns a long long integer value.
  99 .SH "RETURN VALUE"
 100 The
 101 .BR strtol ()
 102 function returns the result of the conversion,
 103 unless the value would underflow or overflow.
 104 If an underflow occurs,
 105 .BR strtol ()
 106 returns
 107 .BR LONG_MIN .
 108 If an overflow occurs,
 109 .BR strtol ()
 110 returns
 111 .BR LONG_MAX .
 112 In both cases, \fIerrno\fP is set to
 113 .BR ERANGE .
 114 Precisely the same holds for
 115 .BR strtoll ()
 116 (with
 117 .B LLONG_MIN
 118 and
 119 .B LLONG_MAX
 120 instead of
 121 .B LONG_MIN
 122 and
 123 .BR LONG_MAX ).
 124 .SH ERRORS
 125 .TP
 126 .B EINVAL
 127 (not in C99)
 128 The given
 129 .I base
 130 contains an unsupported value.
 131 .TP
 132 .B ERANGE
 133 The resulting value was out of range.
 134 .LP
 135 The implementation may also set \fIerrno\fP to \fBEINVAL\fP in case
 136 no conversion was performed (no digits seen, and 0 returned).
 137 .SH "CONFORMING TO"
 138 .BR strtol ()
 139 conforms to SVr4, 4.3BSD, C89, C99 and POSIX.1-2001, and
 140 .BR strtoll ()
 141 to C99 and POSIX.1-2001.
 142 .SH NOTES
 143 Since
 144 .BR strtol ()
 145 can legitimately return 0,
 146 .BR LONG_MAX ,
 147 or
 148 .B LONG_MIN
 149 .RB ( LLONG_MAX
 150 or
 151 .B LLONG_MIN
 152 for
 153 .BR strtoll ())
 154 on both success and failure, the calling program should set
 155 .I errno
 156 to 0 before the call,
 157 and then determine if an error occurred by checking whether
 158 .I errno
 159 has a nonzero value after the call.
 160
 161 In locales other than the "C" locale, other strings may also be accepted.
 162 (For example, the thousands separator of the current locale may be
 163 supported.)
 164 .LP
 165 BSD also has
 166 .sp
 167 .in +4n
 168 .nf
 169 .BI "quad_t strtoq(const char *" nptr ", char **" endptr ", int " base );
 170 .sp
 171 .in
 172 .fi
 173 with completely analogous definition.
 174 Depending on the wordsize of the current architecture, this
 175 may be equivalent to
 176 .BR strtoll ()
 177 or to
 178 .BR strtol ().
 179 .SH EXAMPLE
 180 The program shown below demonstrates the use of
 181 .BR strtol ().
 182 The first command-line argument specifies a string from which
 183 .BR strtol ()
 184 should parse a number.
 185 The second (optional) argument specifies the base to be used for
 186 the conversion.
 187 (This argument is converted to numeric form using
 188 .BR atoi (3),
 189 a function that performs no error checking and
 190 has a simpler interface than
 191 .BR strtol ().)
 192 Some examples of the results produced by this program are the following:
 193 .in +4n
 194 .nf
 195
 196 .RB "$" " ./a.out 123"
 197 strtol() returned 123
 198 .RB "$" " ./a.out \(aq    123\(aq"
 199 strtol() returned 123
 200 .RB "$" " ./a.out 123abc"
 201 strtol() returned 123
 202 Further characters after number: abc
 203 .RB "$" " ./a.out 123abc 55"
 204 strtol: Invalid argument
 205 .RB "$" " ./a.out \(aq\(aq"
 206 No digits were found
 207 .RB "$" " ./a.out 4000000000"
 208 strtol: Numerical result out of range
 209 .fi
 210 .in
 211 .SS Program source
 212 \&
 213 .nf
 214 #include <stdlib.h>
 215 #include <limits.h>
 216 #include <stdio.h>
 217 #include <errno.h>
 218
 219 int
 220 main(int argc, char *argv[])
 221 {
 222     int base;
 223     char *endptr, *str;
 224     long val;
 225
 226     if (argc < 2) {
 227         fprintf(stderr, "Usage: %s str [base]\\n", argv[0]);
 228         exit(EXIT_FAILURE);
 229     }
 230
 231     str = argv[1];
 232     base = (argc > 2) ? atoi(argv[2]) : 10;
 233
 234     errno = 0;    /* To distinguish success/failure after call */
 235     val = strtol(str, &endptr, base);
 236
 237     /* Check for various possible errors */
 238
 239     if ((errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
 240             || (errno != 0 && val == 0)) {
 241         perror("strtol");
 242         exit(EXIT_FAILURE);
 243     }
 244
 245     if (endptr == str) {
 246         fprintf(stderr, "No digits were found\\n");
 247         exit(EXIT_FAILURE);
 248     }
 249
 250     /* If we got here, strtol() successfully parsed a number */
 251
 252     printf("strtol() returned %ld\\n", val);
 253
 254     if (*endptr != \(aq\\0\(aq)        /* Not necessarily an error... */
 255         printf("Further characters after number: %s\\n", endptr);
 256
 257     exit(EXIT_SUCCESS);
 258 }
 259 .fi
 260 .SH "SEE ALSO"
 261 .BR atof (3),
 262 .BR atoi (3),
 263 .BR atol (3),
 264 .BR strtod (3),
 265 .BR strtoul (3)