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
|
|
|
|
|
.\" Chris Torek and 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. All advertising materials mentioning features or use of this software
|
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
|
.\" 4. 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" @(#)strtoul.3 8.1 (Berkeley) 6/4/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
|
|
|
|
.Dd June 4, 1993
|
|
|
|
|
.Dt STRTOUL 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
2001-02-27 13:33:07 +00:00
|
|
|
.Nm strtoul , strtoull , strtouq
|
2001-02-28 12:54:16 +00:00
|
|
|
.Nd "convert a string to an unsigned long, unsigned long long, or uquad_t integer"
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Fd #include <stdlib.h>
|
|
|
|
|
.Fd #include <limits.h>
|
|
|
|
|
.Ft unsigned long
|
|
|
|
|
.Fn strtoul "const char *nptr" "char **endptr" "int base"
|
2001-02-27 13:33:07 +00:00
|
|
|
.Ft unsigned long long
|
|
|
|
|
.Fn strtoull "const char *nptr" "char **endptr" "int base"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fd #include <sys/types.h>
|
|
|
|
|
.Fd #include <stdlib.h>
|
|
|
|
|
.Fd #include <limits.h>
|
|
|
|
|
.Ft u_quad_t
|
|
|
|
|
.Fn strtouq "const char *nptr" "char **endptr" "int base"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn strtoul
|
|
|
|
|
function
|
|
|
|
|
converts the string in
|
|
|
|
|
.Fa nptr
|
|
|
|
|
to an
|
|
|
|
|
.Em unsigned long
|
|
|
|
|
value.
|
|
|
|
|
The
|
2001-02-27 13:33:07 +00:00
|
|
|
.Fn strtoull
|
|
|
|
|
function
|
|
|
|
|
converts the string in
|
|
|
|
|
.Fa nptr
|
|
|
|
|
to an
|
|
|
|
|
.Em unsigned long long
|
|
|
|
|
value.
|
|
|
|
|
The
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fn strtouq
|
|
|
|
|
function
|
|
|
|
|
converts the string in
|
|
|
|
|
.Fa nptr
|
|
|
|
|
to a
|
|
|
|
|
.Em u_quad_t
|
|
|
|
|
value.
|
|
|
|
|
The conversion is done according to the given
|
|
|
|
|
.Fa base ,
|
|
|
|
|
which must be between 2 and 36 inclusive,
|
|
|
|
|
or be the special value 0.
|
|
|
|
|
.Pp
|
|
|
|
|
The string may begin with an arbitrary amount of white space
|
|
|
|
|
(as determined by
|
|
|
|
|
.Xr isspace 3 )
|
|
|
|
|
followed by a single optional
|
|
|
|
|
.Ql +
|
|
|
|
|
or
|
|
|
|
|
.Ql -
|
|
|
|
|
sign.
|
|
|
|
|
If
|
|
|
|
|
.Fa base
|
|
|
|
|
is zero or 16,
|
|
|
|
|
the string may then include a
|
|
|
|
|
.Ql 0x
|
|
|
|
|
prefix,
|
|
|
|
|
and the number will be read in base 16; otherwise, a zero
|
|
|
|
|
.Fa base
|
|
|
|
|
is taken as 10 (decimal) unless the next character is
|
|
|
|
|
.Ql 0 ,
|
|
|
|
|
in which case it is taken as 8 (octal).
|
|
|
|
|
.Pp
|
|
|
|
|
The remainder of the string is converted to an
|
|
|
|
|
.Em unsigned long
|
|
|
|
|
value in the obvious manner,
|
|
|
|
|
stopping at the end of the string
|
|
|
|
|
or at the first character that does not produce a valid digit
|
|
|
|
|
in the given base.
|
|
|
|
|
(In bases above 10, the letter
|
|
|
|
|
.Ql A
|
|
|
|
|
in either upper or lower case
|
|
|
|
|
represents 10,
|
|
|
|
|
.Ql B
|
|
|
|
|
represents 11, and so forth, with
|
|
|
|
|
.Ql Z
|
|
|
|
|
representing 35.)
|
|
|
|
|
.Pp
|
|
|
|
|
If
|
|
|
|
|
.Fa endptr
|
|
|
|
|
is non nil,
|
|
|
|
|
.Fn strtoul
|
|
|
|
|
stores the address of the first invalid character in
|
|
|
|
|
.Fa *endptr .
|
|
|
|
|
If there were no digits at all, however,
|
|
|
|
|
.Fn strtoul
|
|
|
|
|
stores the original value of
|
|
|
|
|
.Fa nptr
|
|
|
|
|
in
|
|
|
|
|
.Fa *endptr .
|
|
|
|
|
(Thus, if
|
|
|
|
|
.Fa *nptr
|
|
|
|
|
is not
|
|
|
|
|
.Ql \e0
|
|
|
|
|
but
|
|
|
|
|
.Fa **endptr
|
|
|
|
|
is
|
|
|
|
|
.Ql \e0
|
|
|
|
|
on return, the entire string was valid.)
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
The
|
|
|
|
|
.Fn strtoul
|
Locale *is* used in strto*l*(), at least for isspace(), so remove
'locale not used' statement from comments and BUGS section of manpage.
strtol(): fix non-portable 'cutoff' calculation using the same method as
in strtoll().
Cleanup 'cutoff' calculation, remove unneded casts. Misc. cleanup to
make all functions looks the same.
Implement EINVAL reaction per POSIX, document it in manpage, corresponding
POSIX example quotes here:
------------------------------------------------
If the subject sequence is empty or does not have the expected form, no
conversion is performed; the value of str is stored in the object pointed
to by endptr, provided that endptr is not a null pointer.
If no conversion could be performed, 0 shall be returned and errno may be
set to [EINVAL].
[EINVAL] The value of base is not supported.
Since 0, {LONG_MIN} or {LLONG_MIN}, and {LONG_MAX} or {LLONG_MAX} are
returned on error and are also valid returns on success, an application
wishing to check for error situations should set errno to 0, then call
strtol( ) or strtoll ( ), then check errno.
-----------------------------------------------------
2001-09-04 16:39:11 +00:00
|
|
|
or
|
|
|
|
|
.Fn strtoull
|
1994-05-27 05:00:24 +00:00
|
|
|
function
|
|
|
|
|
returns either the result of the conversion
|
|
|
|
|
or, if there was a leading minus sign,
|
|
|
|
|
the negation of the result of the conversion,
|
|
|
|
|
unless the original (non-negated) value would overflow;
|
|
|
|
|
in the latter case,
|
|
|
|
|
.Fn strtoul
|
|
|
|
|
returns
|
Locale *is* used in strto*l*(), at least for isspace(), so remove
'locale not used' statement from comments and BUGS section of manpage.
strtol(): fix non-portable 'cutoff' calculation using the same method as
in strtoll().
Cleanup 'cutoff' calculation, remove unneded casts. Misc. cleanup to
make all functions looks the same.
Implement EINVAL reaction per POSIX, document it in manpage, corresponding
POSIX example quotes here:
------------------------------------------------
If the subject sequence is empty or does not have the expected form, no
conversion is performed; the value of str is stored in the object pointed
to by endptr, provided that endptr is not a null pointer.
If no conversion could be performed, 0 shall be returned and errno may be
set to [EINVAL].
[EINVAL] The value of base is not supported.
Since 0, {LONG_MIN} or {LLONG_MIN}, and {LONG_MAX} or {LLONG_MAX} are
returned on error and are also valid returns on success, an application
wishing to check for error situations should set errno to 0, then call
strtol( ) or strtoll ( ), then check errno.
-----------------------------------------------------
2001-09-04 16:39:11 +00:00
|
|
|
.Dv ULONG_MAX
|
|
|
|
|
and
|
2001-02-27 13:33:07 +00:00
|
|
|
.Fn strtoull
|
|
|
|
|
returns
|
|
|
|
|
.Dv ULLONG_MAX .
|
|
|
|
|
In all cases,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Va errno
|
2001-02-27 13:33:07 +00:00
|
|
|
is set to
|
1994-05-27 05:00:24 +00:00
|
|
|
.Er ERANGE .
|
Locale *is* used in strto*l*(), at least for isspace(), so remove
'locale not used' statement from comments and BUGS section of manpage.
strtol(): fix non-portable 'cutoff' calculation using the same method as
in strtoll().
Cleanup 'cutoff' calculation, remove unneded casts. Misc. cleanup to
make all functions looks the same.
Implement EINVAL reaction per POSIX, document it in manpage, corresponding
POSIX example quotes here:
------------------------------------------------
If the subject sequence is empty or does not have the expected form, no
conversion is performed; the value of str is stored in the object pointed
to by endptr, provided that endptr is not a null pointer.
If no conversion could be performed, 0 shall be returned and errno may be
set to [EINVAL].
[EINVAL] The value of base is not supported.
Since 0, {LONG_MIN} or {LLONG_MIN}, and {LONG_MAX} or {LLONG_MAX} are
returned on error and are also valid returns on success, an application
wishing to check for error situations should set errno to 0, then call
strtol( ) or strtoll ( ), then check errno.
-----------------------------------------------------
2001-09-04 16:39:11 +00:00
|
|
|
If no conversion could be performed, 0 shall be returned and
|
|
|
|
|
.Va errno
|
|
|
|
|
will be
|
|
|
|
|
set to
|
|
|
|
|
.Er EINVAL .
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh ERRORS
|
2000-05-06 12:00:11 +00:00
|
|
|
.Bl -tag -width Er
|
Locale *is* used in strto*l*(), at least for isspace(), so remove
'locale not used' statement from comments and BUGS section of manpage.
strtol(): fix non-portable 'cutoff' calculation using the same method as
in strtoll().
Cleanup 'cutoff' calculation, remove unneded casts. Misc. cleanup to
make all functions looks the same.
Implement EINVAL reaction per POSIX, document it in manpage, corresponding
POSIX example quotes here:
------------------------------------------------
If the subject sequence is empty or does not have the expected form, no
conversion is performed; the value of str is stored in the object pointed
to by endptr, provided that endptr is not a null pointer.
If no conversion could be performed, 0 shall be returned and errno may be
set to [EINVAL].
[EINVAL] The value of base is not supported.
Since 0, {LONG_MIN} or {LLONG_MIN}, and {LONG_MAX} or {LLONG_MAX} are
returned on error and are also valid returns on success, an application
wishing to check for error situations should set errno to 0, then call
strtol( ) or strtoll ( ), then check errno.
-----------------------------------------------------
2001-09-04 16:39:11 +00:00
|
|
|
.It Bq Er EINVAL
|
|
|
|
|
The value of base is not supported or
|
|
|
|
|
no conversion could be performed.
|
1994-05-27 05:00:24 +00:00
|
|
|
.It Bq Er ERANGE
|
|
|
|
|
The given string was out of range; the value converted has been clamped.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr strtol 3
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
The
|
|
|
|
|
.Fn strtoul
|
|
|
|
|
function
|
|
|
|
|
conforms to
|
2001-02-26 13:23:47 +00:00
|
|
|
.St -isoC .
|
2001-02-27 13:33:07 +00:00
|
|
|
The
|
|
|
|
|
.Fn strtoull
|
|
|
|
|
function
|
|
|
|
|
conforms to
|
|
|
|
|
.St -isoC-99 .
|
2001-02-28 12:54:16 +00:00
|
|
|
The
|
|
|
|
|
.Bx
|
2001-02-27 13:33:07 +00:00
|
|
|
.Fn strtoq
|
|
|
|
|
function is deprecated.
|
