STRTOUL(3) NEWLIB STRTOUL(3)NAME
2.37 `strtoul'--string to unsigned long
SYNOPSIS
#include <stdlib.h>
unsigned long strtoul(const char *S, char **PTR,
int BASE);
unsigned long _strtoul_r(void *REENT, const char *S,
char **PTR, int BASE);
DESCRIPTION
The function `strtoul' converts the string `*S' to an `unsigned long'.
First, it breaks down the string into three parts: leading whitespace,
which is ignored; a subject string consisting of the digits meaningful
in the radix specified by BASE (for example, `0' through `7' if the
value of BASE is 8); and a trailing portion consisting of one or more
unparseable characters, which always includes the terminating null
character. Then, it attempts to convert the subject string into an
unsigned long integer, and returns the result.
If the value of BASE is zero, the subject string is expected to look
like a normal C integer constant (save that no optional sign is permit‐
ted): a possible `0x' indicating hexadecimal radix, and a number. If
BASE is between 2 and 36, the expected form of the subject is a
sequence of digits (which may include letters, depending on the base)
representing an integer in the radix specified by BASE. The letters
`a'-`z' (or `A'-`Z') are used as digits valued from 10 to 35. If BASE
is 16, a leading `0x' is permitted.
The subject sequence is the longest initial sequence of the input
string that has the expected form, starting with the first non-white‐
space character. If the string is empty or consists entirely of white‐
space, or if the first non-whitespace character is not a permissible
digit, the subject string is empty.
If the subject string is acceptable, and the value of BASE is zero,
`strtoul' attempts to determine the radix from the input string. A
string with a leading `0x' is treated as a hexadecimal value; a string
with a leading `0' and no `x' is treated as octal; all other strings
are treated as decimal. If BASE is between 2 and 36, it is used as the
conversion radix, as described above. Finally, a pointer to the first
character past the converted subject string is stored in PTR, if PTR is
not `NULL'.
If the subject string is empty (that is, if `*'S does not start with
a substring in acceptable form), no conversion is performed and the
value of S is stored in PTR (if PTR is not `NULL').
The alternate function `_strtoul_r' is a reentrant version. The
extra argument REENT is a pointer to a reentrancy structure.
RETURNS
`strtoul' returns the converted value, if any. If no conversion was
made, `0' is returned.
`strtoul' returns `ULONG_MAX' if the magnitude of the converted
value is too large, and sets `errno' to `ERANGE'.
PORTABILITY
`strtoul' is ANSI.
`strtoul' requires no supporting OS subroutines.
SEE ALSOstrtoul is part of the library. The full documentation for is main‐
tained as a Texinfo manual. If info and are properly installed at your
site, the command
info
will give you access to the complete manual.
NEWLIB April 2010 STRTOUL(3)
