std::stoul

unsigned long stoul (const string&  str, size_t* idx = 0, int base = 10);unsigned long stoul (const wstring& str, size_t* idx = 0, int base = 10);

Convert string to unsigned integer

Parses str interpreting its content as an integral number of the specified base, which is returned as an unsigned long value.

If idx is not a null pointer, the function also sets the value of idx to the position of the first character in str after the number.

The function uses strtoul (or wcstoul) to perform the conversion (see strtol for more details on the process).

Parameters

str: String object with the representation of an integral number.
idx: Pointer to an object of type size_t, whose value is set by the function to position of the next character in str after the numerical value.
This parameter can also be a null pointer, in which case it is not used.
base: Numerical base (radix) that determines the valid characters and their interpretation.
If this is 0, the base used is determined by the format in the sequence (see strtol for details). Notice that by default this argument is 10, not 0.

Return Value

On success, the function returns the converted integral number as an unsigned long value.

Example

// stoul example
#include <iostream>   // std::cin, std::cout
#include <string>     // std::string, std::stoul, std::getline

int main ()
{
  std::string str;
  std::cout << "Enter an unsigned number: ";
  std::getline (std::cin,str);
  unsigned long ul = std::stoul (str,nullptr,0);
  std::cout << "You entered: " << ul << '\n';
  return 0;
}

Complexity

Unspecified, but generally linear in the number of characters interpreted.

Data races

Modifies the value pointed by idx (if not zero).

Exceptions

If no conversion could be performed, an invalid_argument exception is thrown.

If the value read is out of the range of representable values by an unsigned long, an out_of_range exception is thrown.

An invalid idx causes undefined behavior.

class templates

classes

functions