STRTOUL
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
NAME
strtoul, strtouq
- convert a string to an unsigned long or uquad_t integer
SYNOPSIS
Fd #include <stdlib.h>
Fd #include <limits.h>
Ft unsigned long
Fn strtoul const char *nptr char **endptr int base
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
DESCRIPTION
The
Fn strtoul
function
converts the string in
Fa nptr
to an
unsigned long
value.
The
Fn strtouq
function
converts the string in
Fa nptr
to a
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.
The string may begin with an arbitrary amount of white space
(as determined by
isspace(3))
followed by a single optional
`+'
or
`-'
sign.
If
Fa base
is zero or 16,
the string may then include a
`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
`0'
,
in which case it is taken as 8 (octal).
The remainder of the string is converted to an
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
`A'
in either upper or lower case
represents 10,
`B'
represents 11, and so forth, with
`Z'
representing 35.)
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
`\0'
but
Fa **endptr
is
`\0'
on return, the entire string was valid.)
RETURN VALUES
The
Fn strtoul
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
ULONG_MAX
and sets the global variable
errno
to
Er ERANGE .
ERRORS
- Bq Er ERANGE
-
The given string was out of range; the value converted has been clamped.
SEE ALSO
strtol(3)
STANDARDS
The
Fn strtoul
function
conforms to
St -ansiC .
BUGS
Ignores the current locale.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- SEE ALSO
-
- STANDARDS
-
- BUGS
-
This document was created by
man2html,
using the manual pages.
Time: 15:52:52 GMT, January 15, 2023