STRTOUL(3) BSD Library Functions Manual STRTOUL(3)

NAME
     ssttrrttoouull, ssttrrttoouullll, ssttrrttoouummaaxx, ssttrrttoouuqq - convert a string to an unsigned
     long, unsigned long long, uintmaxt, or uquadt integer

LLIIBBRRAARRYY
     Standard C Library (libc, -lc)

SYNOPSIS
     ##iinncclluuddee <>
     ##iinncclluuddee <>

     unsigned long
     ssttrrttoouull(const char * restrict nptr, char ** restrict endptr, int base);

     unsigned long long
     ssttrrttoouullll(const char * restrict nptr, char ** restrict endptr, int base);

     ##iinncclluuddee <>

     uintmaxt
     ssttrrttoouummaaxx(const char * restrict nptr, char ** restrict endptr, int base);

     ##iinncclluuddee <>
     ##iinncclluuddee <>
     ##iinncclluuddee <>

     uquadt
     ssttrrttoouuqq(const char *nptr, char **endptr, int base);

DESCRIPTION
     The ssttrrttoouull() function converts the string in nptr to an unsigned long
     value.  The ssttrrttoouullll() function converts the string in nptr to an
     unsigned long long value.  The ssttrrttoouummaaxx() function converts the string
     in nptr to an uintmaxt value.  The ssttrrttoouuqq() function converts the
     string in nptr to a uquadt value.  The conversion is done according to
     the given base, which must be between 2 and 36 inclusive, or be the spe-
     cial value 0.

     The string may begin with an arbitrary amount of white space (as deter-
     mined by isspace(3)) followed by a single optional `+' or `-' sign.  If
     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 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 charac-
     ter 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 endptr is not NULL, ssttrrttoouull() stores the address of the first invalid
     character in *endptr.  If there were no digits at all, however, ssttrrttoouull()
     stores the original value of nptr in *endptr.  (Thus, if *nptr is not
     `\0' but **endptr is `\0' on return, the entire string was valid.)

RETURN VALUES
     The ssttrrttoouull(), ssttrrttoouullll(), ssttrrttoouummaaxx() and ssttrrttoouuqq() functions return
     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, ssttrrttoouull() returns
     ULONGMAX, ssttrrttoouullll() returns ULLONGMAX, ssttrrttoouummaaxx() returns
     UINTMAXMAX, and ssttrrttoouuqq() returns ULLONGMAX.  In all cases, errno is
     set to ERANGE.  If no conversion could be performed, 0 is returned and
     the global variable errno is set to EINVAL.

EERRRROORRSS
     [EINVAL]           The value of base is not supported or no conversion
                        could be performed.

     [ERANGE]           The given string was out of range; the value converted
                        has been clamped.

SEE ALSO
     strtol(3), wcstoul(3), strtoll(3)

STANDARDS     The ssttrrttoouull() function conforms to ISO/IEC 9899:1990 (``ISO C90'').  The
     ssttrrttoouullll() and ssttrrttoouummaaxx() functions conform to ISO/IEC 9899:1999
     (``ISO C99'').  The BSD ssttrrttoouuqq() function is deprecated.

BSD                            November 28, 2001                           BSD