Namespaces
Variants
Views
Actions

strtoimax, strtoumax

From cppreference.com
< c‎ | string‎ | byte
Revision as of 13:07, 10 April 2013 by P12 (Talk | contribs)

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <inttypes.h>
</td>

<td></td> <td></td> <tr class="t-dcl ">

<td >
intmax_t strtoimax( const char *restrict nptr,
                    char **restrict endptr, int base );
</td>

<td class="t-dcl-nopad"> </td> <td > (since C99) </td> </tr> <tr class="t-dcl ">

<td >
uintmax_t strtoumax( const char *restrict nptr,
                     char **restrict endptr, int base );
</td>

<td class="t-dcl-nopad"> </td> <td > (since C99) </td> </tr> Template:ddcl list end

Interprets an integer value in a byte string pointed to by nptr.

Function discards any whitespace characters (as identified by calling isspace()) until first non-whitespace character is found. Then it takes as many characters as possible to form a valid base-n (where n=base) integer number representation and converts them to an integer value. The valid integer value consists of the following parts:

  • (optional) plus or minus sign
  • (optional) prefix (0) indicating octal base (applies only when the base is 8 or 0)
  • (optional) prefix (0x or 0X) indicating hexadecimal base (applies only when the base is 16 or 0)
  • a sequence of digits

The set of valid digits for base-2 integer is 01, for base-3 integer is 012, and so on. For bases larger than 10, valid digits include alphabetic characters, starting from Aa for base-11 integer, to Zz for base-36 integer. The case of the characters is ignored. In non-default locales, additional numeric formats may be accepted.

If the value of base is 0, the numeric base is auto-detected: if the prefix is 0, the base is octal, if the prefix is 0x or 0X, the base is hexadecimal, otherwise the base is decimal.

The functions sets the pointer pointed to by endptr to point to the character past the last character interpreted. If endptr is NULL, it is ignored.

If the nptr is empty or does not have the expected form, no conversion is performed, and (if enptr is not NULL) the value of nptr is stored in the object pointed to by endptr.

Contents

Parameters

nptr - pointer to the null-terminated byte string to be interpreted
endptr - pointer to a pointer to character.
base - base of the interpreted integer value

Return value

  • If successful, an integer value corresponding to the contents of str is returned.
  • If the converted value falls out of range of corresponding return type, a range error occurs (setting errno to ERANGE) and INTMAX_MAX, INTMAX_MIN, UINTMAX_MAX or 0 is returned, as appropriate.
  • If no conversion can be performed, 0 is returned.

Example

See also

Template:c/string/wide/dcl list wcstoimaxTemplate:c/string/byte/dcl list strtolTemplate:c/string/byte/dcl list strtoul
C++ documentation for strtoimax, strtoumax