git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" the American National Standards Committee X3, on Information
	6	.\" Processing Systems.
	7	.\"
	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)atoi.3 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/lib/libc/stdlib/atoi.3,v 1.14 2007/10/19 06:23:39 davidxu Exp $
	34	.\"
	35	.Dd June 4, 1993
	36	.Dt ATOI 3
	37	.Os
	38	.Sh NAME
	39	.Nm atoi ,
	40	.Nm atoi_l
	41	.Nd convert
	42	.Tn ASCII
	43	string to integer
	44	.Sh LIBRARY
	45	.Lb libc
	46	.Sh SYNOPSIS
	47	.In stdlib.h
	48	.Ft int
	49	.Fn atoi "const char *str"
	50	.In xlocale.h
	51	.Ft int
	52	.Fn atoi_l "const char *str" "locale_t loc"
	53	.Sh DESCRIPTION
	54	The
	55	.Fn atoi
	56	function converts the initial portion of the string pointed to by
	57	.Fa str
	58	to
	59	.Vt int
	60	representation.
	61	.Pp
	62	It is equivalent to:
	63	.Bd -literal -offset indent
	64	(int)strtol(str, (char **)NULL, 10);
	65	.Ed
	66	.Pp
	67	While the
	68	.Fn atoi
	69	function uses the current locale, the
	70	.Fn atoi_l
	71	function may be passed a locale directly. See
	72	.Xr xlocale 3
	73	for more information.
	74	.Sh IMPLEMENTATION NOTES
	75	The
	76	.Fn atoi
	77	and
	78	.Fn atoi_l
	79	functions are thread-safe and async-cancel-safe.
	80	.Pp
	81	The
	82	.Fn atoi
	83	and
	84	.Fn atoi_l
	85	functions have been deprecated by
	86	.Fn strtol
	87	and
	88	.Fn strtol_l
	89	and should not be used in new code.
	90	.Sh ERRORS
	91	The function
	92	.Fn atoi
	93	need not affect the value of
	94	.Va errno
	95	on an error.
	96	.Sh SEE ALSO
	97	.Xr atof 3 ,
	98	.Xr atol 3 ,
	99	.Xr strtod 3 ,
	100	.Xr strtol 3 ,
	101	.Xr strtoul 3 ,
	102	.Xr xlocale 3
	103	.Sh STANDARDS
	104	The
	105	.Fn atoi
	106	function conforms to
	107	.St -p1003.1-90 ,
	108	.St -isoC ,
	109	and
	110	.St -isoC-99 .