C++ <cinttypes> - strtoumax() Function

The C++ <cinttypes> strtoumax() function is used to interpret an integer value of the specified base in a byte string pointed to by str.

The function first discards any whitespace characters (as determined by isspace()) until the first non-whitespace character is found. Then, starting from this character, takes an optional initial plus or minus sign followed by as many characters as possible to form a valid integer number (of specified base) representation and converts them to an integer value.

The valid integer value consists of the following parts:

• (optional) plus or minus sign
• (optional) prefix indicating octal or hexadecimal base ("0" or "0x"/"0X" respectively)
• a sequence of digits.

The set of valid values for base is {0,2,3,...,36}. The set of valid digits for base-2 integers is {0,1}, for base-3 integers is {0,1,2}, 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.

For locales other than the "C" locale, 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.

If str_end is not a null pointer, the function also sets the value of str_end to point to the first character after the number. If str_end is a null pointer, it is ignored.

If the first sequence of non-whitespace characters in str is not a valid integral number, or if no such sequence exists (because either empty or contains only whitespaces), no conversion is performed and zero is returned.

Syntax

• C++11

uintmax_t strtoumax (const char* str, char** str_end, int base);

Parameters

Return Value

On success, the function returns the converted integral number as a value of type uintmax_t. If no conversion can be performed, zero is returned. If the converted value falls out of the range, UINTMAX_MAX is returned, and errno is set to ERANGE.

Example 1:

The example below shows the usage of <cinttypes> strtoumax() function.

#include <cstdio>
#include <cinttypes>

int main (){
  char str1[] = "123";
  char str2[] = "10.55";
  char str3[] = "100 some words";
  char str4[] = "some words 555";

  char *end;

  uintmax_t num1 = strtoumax(str1, &end, 10);
  uintmax_t num2 = strtoumax(str2, &end, 10);
  uintmax_t num3 = strtoumax(str3, &end, 10);
  uintmax_t num4 = strtoumax(str4, NULL, 10);

  //displaying the result
  printf("strtoumax(\"%s\") = %" PRIuMAX "\n", str1, num1);
  printf("strtoumax(\"%s\") = %" PRIuMAX "\n", str2, num2);
  printf("strtoumax(\"%s\") = %" PRIuMAX "\n", str3, num3);
  printf("strtoumax(\"%s\") = %" PRIuMAX "\n", str4, num4);

  return 0;
}

The output of the above code will be:

strtoumax("123") = 123
strtoumax("10.55") = 10
strtoumax("100 some words") = 100
strtoumax("some words 555") = 0

Example 2:

Consider the example below where the string contains multiple integral values. The second parameter if not a null pointer then this function sets this parameter to value which points to the first character after the interpreted number. This feature can be used to interpret multiple integral values from the string.

#include <cstdio>
#include <cinttypes>

int main (){
  char str[] = "123 10 555";
  char *pEnd;

  uintmax_t val1 = strtoumax(str, &pEnd, 10);
  uintmax_t val2 = strtoumax(pEnd, &pEnd, 10);
  uintmax_t val3 = strtoumax(pEnd, &pEnd, 10);

  //displaying the result
  printf("val1 = %" PRIuMAX "\n", val1);
  printf("val2 = %" PRIuMAX "\n", val2);
  printf("val3 = %" PRIuMAX "\n", val3);

  return 0;
}

The output of the above code will be:

val1 = 123
val2 = 10
val3 = 555

Example 3:

Consider one more example where the third parameter of this function is used to interpret integral values in different bases.

#include <cstdio>
#include <cinttypes>

int main (){
  char str[] = "11011 55 123 ff 0xff";
  char *pEnd;

  uintmax_t val1 = strtoumax(str, &pEnd, 2);
  uintmax_t val2 = strtoumax(pEnd, &pEnd, 8);
  uintmax_t val3 = strtoumax(pEnd, &pEnd, 10);
  uintmax_t val4 = strtoumax(pEnd, &pEnd, 16);
  uintmax_t val5 = strtoumax(pEnd, &pEnd, 0);

  //displaying the result
  printf("val1 = %" PRIuMAX "\n", val1);
  printf("val2 = %" PRIuMAX "\n", val2);
  printf("val3 = %" PRIuMAX "\n", val3);
  printf("val4 = %" PRIuMAX "\n", val4);
  printf("val5 = %" PRIuMAX "\n", val5);

  return 0;
}

The output of the above code will be:

val1 = 27
val2 = 45
val3 = 123
val4 = 255
val5 = 255