freebsd-nq/lib/libc/stdlib/atoi.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)atoi.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd April 1, 2020
.Dt ATOI 3
.Os
.Sh NAME
.Nm atoi
.Nd convert
.Tn ASCII
string to integer
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft int
.Fn atoi "const char *nptr"
.Sh DESCRIPTION
The
.Fn atoi
function converts the initial portion of the string pointed to by
.Fa nptr
to
.Vt int
representation.
.Pp
It is equivalent to:
.Bd -literal -offset indent
(int)strtol(nptr, NULL, 10);
.Ed
.Pp
The
.Fn atoi
function has been deprecated by
.Fn strtol
and should not be used in new code.
.Sh ERRORS
The function
.Fn atoi
need not affect the value of
.Va errno
on an error.
.Sh SEE ALSO
.Xr atof 3 ,
.Xr atol 3 ,
.Xr strtod 3 ,
.Xr strtol 3 ,
.Xr strtoul 3
.Sh STANDARDS
The
.Fn atoi
function conforms to
.St -p1003.1-90 ,
.St -isoC ,
and
.St -isoC-99 .
.Sh HISTORY
The
.Fn atoi
function appeared in
.At v1 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the American National Standards Committee X3, on Information`
			`.\" Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber clauses to reduce diffs to other versions NetBSD, OpenBSD, and Android's Bionic number the clauses 1 through 3, so follow suit to make comparison easier. 2013-05-28 20:57:40 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)atoi.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Note some functions that appeared in First Edition Unix These functions first appeared in the First Edition of Unix (or earlier in the pdp-7 version). Just claim 1st Edition for all this. The pdp-7 code is too fragmented at this point to extend history that far back. 2020-04-01 22:50:41 +00:00			`.Dd April 1, 2020`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt ATOI 3`
			`.Os`
			`.Sh NAME`
			`.Nm atoi`
			`.Nd convert`
			`.Tn ASCII`
			`string to integer`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
Move to using .In instead of .Fd #include <> for include mark-up. Inspired by comment from: dd 2001-09-07 14:46:36 +00:00			`.In stdlib.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn atoi "const char *nptr"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn atoi`
			`function converts the initial portion of the string pointed to by`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa nptr`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`to`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Vt int`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`representation.`
			`.Pp`
			`It is equivalent to:`
			`.Bd -literal -offset indent`
libc: remove explicit cast NULL in atoi There isn't any reason to cast NULL so just remove it. Noticed when cleaning up top. Reviewed by: pstef 2018-06-13 08:52:17 +00:00			`(int)strtol(nptr, NULL, 10);`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ed`
Add ERRORS section. Mention thread safety and async-cancel safety status [not]. Add standards compliancy references. Note strtol() is preferred over atoi(). MFC after: 2 weeks 2001-09-26 20:22:44 +00:00			`.Pp`
			`The`
mdoc(7) police: s/atof/atoi/ 2001-10-01 12:44:24 +00:00			`.Fn atoi`
Add ERRORS section. Mention thread safety and async-cancel safety status [not]. Add standards compliancy references. Note strtol() is preferred over atoi(). MFC after: 2 weeks 2001-09-26 20:22:44 +00:00			`function has been deprecated by`
			`.Fn strtol`
			`and should not be used in new code.`
			`.Sh ERRORS`
Back out errno preserving 2001-12-30 03:34:46 +00:00			`The function`
Add ERRORS section. Mention thread safety and async-cancel safety status [not]. Add standards compliancy references. Note strtol() is preferred over atoi(). MFC after: 2 weeks 2001-09-26 20:22:44 +00:00			`.Fn atoi`
mdoc(7) police: add missing markup bits for ``errno''. 2002-01-09 14:03:54 +00:00			`need not affect the value of`
			`.Va errno`
			`on an error.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr atof 3 ,`
			`.Xr atol 3 ,`
			`.Xr strtod 3 ,`
			`.Xr strtol 3 ,`
			`.Xr strtoul 3`
			`.Sh STANDARDS`
			`The`
			`.Fn atoi`
			`function conforms to`
Add ERRORS section. Mention thread safety and async-cancel safety status [not]. Add standards compliancy references. Note strtol() is preferred over atoi(). MFC after: 2 weeks 2001-09-26 20:22:44 +00:00			`.St -p1003.1-90 ,`
			`.St -isoC ,`
			`and`
			`.St -isoC-99 .`
Note some functions that appeared in First Edition Unix These functions first appeared in the First Edition of Unix (or earlier in the pdp-7 version). Just claim 1st Edition for all this. The pdp-7 code is too fragmented at this point to extend history that far back. 2020-04-01 22:50:41 +00:00			`.Sh HISTORY`
			`The`
			`.Fn atoi`
			`function appeared in`
			`.At v1 .`