Libc-594.1.4.tar.gz

[apple/libc.git] / stdlib / atoi.3

diff --git a/stdlib/atoi.3 b/stdlib/atoi.3
index 40ac0281a3cac2a737206f41b978eab04c3f841b..700227421b130361c05f4e7cfc6a8057b8cf2b84 100644 (file)
--- a/stdlib/atoi.3
+++ b/stdlib/atoi.3
@@ -34,13 +34,14 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)atoi.3     8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/stdlib/atoi.3,v 1.8 2001/10/01 12:44:24 ru Exp $
+.\" $FreeBSD: src/lib/libc/stdlib/atoi.3,v 1.12 2002/12/18 13:33:03 ru Exp $
 .\"
 .Dd June 4, 1993
 .Dt ATOI 3
 .Os
 .Sh NAME
-.Nm atoi
+.Nm atoi ,
+.Nm atoi_l
 .Nd convert
 .Tn ASCII
 string to integer
@@ -49,20 +50,31 @@ string to integer
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft int
-.Fn atoi "const char *nptr"
+.Fn atoi "const char *str"
+.In xlocale.h
+.Ft int
+.Fn atoi_l "const char *str" "locale_t loc"
 .Sh DESCRIPTION
 The
 .Fn atoi
 function converts the initial portion of the string pointed to by
-.Em nptr
+.Fa str
 to
-.Em integer
+.Vt int
 representation.
 .Pp
 It is equivalent to:
 .Bd -literal -offset indent
-(int)strtol(nptr, (char **)NULL, 10);
+(int)strtol(str, (char **)NULL, 10);
 .Ed
+.Pp
+While the
+.Fn atoi
+function uses the current locale, the
+.Fn atoi_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh IMPLEMENTATION NOTES
 The
 .Fn atoi
@@ -74,15 +86,18 @@ function has been deprecated by
 .Fn strtol
 and should not be used in new code.
 .Sh ERRORS
-The
+The function
 .Fn atoi
-function does not detect errors.
+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
+.Xr strtoul 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn atoi