original/man3/atoi.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 Mon Mar 29 22:39:41 1993, David Metcalfe
  30 .\" Modified Sat Jul 24 21:38:42 1993, Rik Faith (faith@cs.unc.edu)
  31 .\" Modified Sun Dec 17 18:35:06 2000, Joseph S. Myers
  32 .\"
  33 .TH ATOI 3  2014-01-22 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 atoi, atol, atoll, atoq \- convert a string to an integer
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <stdlib.h>
  39 .sp
  40 .BI "int atoi(const char *" nptr );
  41 .br
  42 .BI "long atol(const char *" nptr );
  43 .br
  44 .BI "long long atoll(const char *" nptr );
  45 .br
  46 .BI "long long atoq(const char *" nptr );
  47 .fi
  48 .sp
  49 .in -4n
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .in
  53 .sp
  54 .ad l
  55 .BR atoll ():
  56 .RS 4
  57 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  58 _POSIX_C_SOURCE\ >=\ 200112L;
  59 .br
  60 or
  61 .I cc\ -std=c99
  62 .RE
  63 .ad
  64 .SH DESCRIPTION
  65 The
  66 .BR atoi ()
  67 function converts the initial portion of the string
  68 pointed to by \fInptr\fP to
  69 .IR int .
  70 The behavior is the same as
  71 .sp
  72 .in +4n
  73 strtol(nptr, NULL, 10);
  74 .in
  75 .sp
  76 except that
  77 .BR atoi ()
  78 does not detect errors.
  79 .PP
  80 The
  81 .BR atol ()
  82 and
  83 .BR atoll ()
  84 functions behave the same as
  85 .BR atoi (),
  86 except that they convert the initial portion of the
  87 string to their return type of \fIlong\fP or \fIlong long\fP.
  88 .BR atoq ()
  89 is an obsolete name for
  90 .BR atoll ().
  91 .SH RETURN VALUE
  92 The converted value.
  93 .SH ATTRIBUTES
  94 .SS Multithreading (see pthreads(7))
  95 The
  96 .BR atoi (),
  97 .BR atol (),
  98 and
  99 .BR atoll ()
 100 functions are thread-safe with exceptions.
 101 These functions can be safely used in multithreaded applications,
 102 as long as
 103 .BR setlocale (3)
 104 is not called to change the locale during their execution.
 105 .SH CONFORMING TO
 106 SVr4, POSIX.1-2001, 4.3BSD, C99.
 107 C89 and
 108 POSIX.1-1996 include the functions
 109 .BR atoi ()
 110 and
 111 .BR atol ()
 112 only.
 113 .BR atoq ()
 114 is a GNU extension.
 115 .SH NOTES
 116 The nonstandard
 117 .BR atoq ()
 118 function is not present in libc 4.6.27
 119 or glibc 2, but is present in libc5 and libc 4.7 (though only as an
 120 inline function in \fI<stdlib.h>\fP until libc 5.4.44).
 121 The
 122 .BR atoll ()
 123 function is present in glibc 2 since version 2.0.2, but
 124 not in libc4 or libc5.
 125 .SH SEE ALSO
 126 .BR atof (3),
 127 .BR strtod (3),
 128 .BR strtol (3),
 129 .BR strtoul (3)
 130 .SH COLOPHON
 131 This page is part of release 3.68 of the Linux
 132 .I man-pages
 133 project.
 134 A description of the project,
 135 information about reporting bugs,
 136 and the latest version of this page,
 137 can be found at
 138 \%http://www.kernel.org/doc/man\-pages/.