original/man3/strtol.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   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.
   7 .\"
   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.
  12 .\"
  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
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  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"
  32 .SH NAME
  33 strtol, strtoll, strtoq \- convert a string to a long integer
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <stdlib.h>
  37 .sp
  38 .BI "long int strtol(const char *" nptr ", char **" endptr ", int " base );
  39 .sp
  40 .BI "long long int strtoll(const char *" nptr ", char **" endptr \
  41 ", int " base );
  42 .fi
  43 .sp
  44 .in -4n
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .in
  48 .sp
  49 .ad l
  50 .BR strtoll ():
  51 .RS 4
  52 _XOPEN_SOURCE\ >=\ 600 || _BSD_SOURCE || _SVID_SOURCE || _ISOC99_SOURCE ||
  53 _POSIX_C_SOURCE\ >=\ 200112L;
  54 .br
  55 or
  56 .I cc\ -std=c99
  57 .RE
  58 .ad
  59 .SH DESCRIPTION
  60 The
  61 .BR strtol ()
  62 function converts the initial part of the string
  63 in
  64 .I nptr
  65 to a long integer value according to the given
  66 .IR base ,
  67 which must be between 2 and 36 inclusive, or be the special value 0.
  68 .PP
  69 The string may begin with an arbitrary amount of white space (as
  70 determined by
  71 .BR isspace (3))
  72 followed by a single optional \(aq+\(aq or \(aq\-\(aq sign.
  73 If
  74 .I base
  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
  77 zero
  78 .I base
  79 is taken as 10 (decimal) unless the next character
  80 is \(aq0\(aq, in which case it is taken as 8 (octal).
  81 .PP
  82 The remainder of the string is converted to a
  83 .I long int
  84 value
  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.)
  90 .PP
  91 If
  92 .I endptr
  93 is not NULL,
  94 .BR strtol ()
  95 stores the address of the
  96 first invalid character in
  97 .IR *endptr .
  98 If there were no digits at
  99 all,
 100 .BR strtol ()
 101 stores the original value of
 102 .I nptr
 103 in
 104 .I *endptr
 105 (and returns 0).
 106 In particular, if
 107 .I *nptr
 108 is not \(aq\\0\(aq but
 109 .I **endptr
 110 is \(aq\\0\(aq on return, the entire string is valid.
 111 .PP
 112 The
 113 .BR strtoll ()
 114 function works just like the
 115 .BR strtol ()
 116 function but returns a long long integer value.
 117 .SH RETURN VALUE
 118 The
 119 .BR strtol ()
 120 function returns the result of the conversion,
 121 unless the value would underflow or overflow.
 122 If an underflow occurs,
 123 .BR strtol ()
 124 returns
 125 .BR LONG_MIN .
 126 If an overflow occurs,
 127 .BR strtol ()
 128 returns
 129 .BR LONG_MAX .
 130 In both cases,
 131 .I errno
 132 is set to
 133 .BR ERANGE .
 134 Precisely the same holds for
 135 .BR strtoll ()
 136 (with
 137 .B LLONG_MIN
 138 and
 139 .B LLONG_MAX
 140 instead of
 141 .B LONG_MIN
 142 and
 143 .BR LONG_MAX ).
 144 .SH ERRORS
 145 .TP
 146 .B EINVAL
 147 (not in C99)
 148 The given
 149 .I base
 150 contains an unsupported value.
 151 .TP
 152 .B ERANGE
 153 The resulting value was out of range.
 154 .LP
 155 The implementation may also set
 156 .IR errno
 157 to
 158 .B EINVAL
 159 in case
 160 no conversion was performed (no digits seen, and 0 returned).
 161 .SH ATTRIBUTES
 162 .SS Multithreading (see pthreads(7))
 163 The
 164 .BR strtol (),
 165 .BR strtoll (),
 166 and
 167 .BR strtoq ()
 168 functions are thread-safe with exceptions.
 169 These functions can be safely used in multithreaded applications,
 170 as long as
 171 .BR setlocale (3)
 172 is not called to change the locale during their execution.
 173 .SH CONFORMING TO
 174 .BR strtol ()
 175 conforms to SVr4, 4.3BSD, C89, C99, and POSIX.1-2001, and
 176 .BR strtoll ()
 177 to C99 and POSIX.1-2001.
 178 .SH NOTES
 179 Since
 180 .BR strtol ()
 181 can legitimately return 0,
 182 .BR LONG_MAX ,
 183 or
 184 .B LONG_MIN
 185 .RB ( LLONG_MAX
 186 or
 187 .B LLONG_MIN
 188 for
 189 .BR strtoll ())
 190 on both success and failure, the calling program should set
 191 .I errno
 192 to 0 before the call,
 193 and then determine if an error occurred by checking whether
 194 .I errno
 195 has a nonzero value after the call.
 196
 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.
 201 .LP
 202 BSD also has
 203 .sp
 204 .in +4n
 205 .nf
 206 .BI "quad_t strtoq(const char *" nptr ", char **" endptr ", int " base );
 207 .sp
 208 .in
 209 .fi
 210 with completely analogous definition.
 211 Depending on the wordsize of the current architecture, this
 212 may be equivalent to
 213 .BR strtoll ()
 214 or to
 215 .BR strtol ().
 216 .SH EXAMPLE
 217 The program shown below demonstrates the use of
 218 .BR strtol ().
 219 The first command-line argument specifies a string from which
 220 .BR strtol ()
 221 should parse a number.
 222 The second (optional) argument specifies the base to be used for
 223 the conversion.
 224 (This argument is converted to numeric form using
 225 .BR atoi (3),
 226 a function that performs no error checking and
 227 has a simpler interface than
 228 .BR strtol ().)
 229 Some examples of the results produced by this program are the following:
 230 .in +4n
 231 .nf
 232
 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"
 243 No digits were found
 244 .RB "$" " ./a.out 4000000000"
 245 strtol: Numerical result out of range
 246 .fi
 247 .in
 248 .SS Program source
 249 \&
 250 .nf
 251 #include <stdlib.h>
 252 #include <limits.h>
 253 #include <stdio.h>
 254 #include <errno.h>
 255
 256 int
 257 main(int argc, char *argv[])
 258 {
 259     int base;
 260     char *endptr, *str;
 261     long val;
 262
 263     if (argc < 2) {
 264         fprintf(stderr, "Usage: %s str [base]\\n", argv[0]);
 265         exit(EXIT_FAILURE);
 266     }
 267
 268     str = argv[1];
 269     base = (argc > 2) ? atoi(argv[2]) : 10;
 270
 271     errno = 0;    /* To distinguish success/failure after call */
 272     val = strtol(str, &endptr, base);
 273
 274     /* Check for various possible errors */
 275
 276     if ((errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
 277             || (errno != 0 && val == 0)) {
 278         perror("strtol");
 279         exit(EXIT_FAILURE);
 280     }
 281
 282     if (endptr == str) {
 283         fprintf(stderr, "No digits were found\\n");
 284         exit(EXIT_FAILURE);
 285     }
 286
 287     /* If we got here, strtol() successfully parsed a number */
 288
 289     printf("strtol() returned %ld\\n", val);
 290
 291     if (*endptr != \(aq\\0\(aq)        /* Not necessarily an error... */
 292         printf("Further characters after number: %s\\n", endptr);
 293
 294     exit(EXIT_SUCCESS);
 295 }
 296 .fi
 297 .SH SEE ALSO
 298 .BR atof (3),
 299 .BR atoi (3),
 300 .BR atol (3),
 301 .BR strtod (3),
 302 .BR strtoul (3)
 303 .SH COLOPHON
 304 This page is part of release 3.64 of the Linux
 305 .I man-pages
 306 project.
 307 A description of the project,
 308 and information about reporting bugs,
 309 can be found at
 310 \%http://www.kernel.org/doc/man\-pages/.