Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/string/basic string/stoul"

From cppreference.com
< cpp‎ | string‎ | basic string
m (maybe we need {{ci}} ~= <i>{{c}}</i> ?)
(Undo revision. This is just an internal variable, like the intermediate variable 'c' in the swapping prodecure 'c = a; a = b; b = c;'. There is no point to emphasize the exposition-only nature of something never being used elsewhere.)
 
Line 23: Line 23:
 
Interprets an unsigned integer value in the string {{c|str}}.
 
Interprets an unsigned integer value in the string {{c|str}}.
  
−
Let ''{{c|ptr}}'' be an internal (to the conversion functions) pointer of type {{c/core|char*}} {{v|1,3}} or {{c/core|wchar_t*}} {{v|2,4}}, accordingly.
+
Let {{c|ptr}} be an internal (to the conversion functions) pointer of type {{c/core|char*}} {{v|1,3}} or {{c/core|wchar_t*}} {{v|2,4}}, accordingly.
  
 
@1@ Calls {{c|std::strtoul(str.c_str(), &ptr, base)}}.
 
@1@ Calls {{c|std::strtoul(str.c_str(), &ptr, base)}}.
Line 32: Line 32:
 
{{cpp/string/cvt str2int base|base={{c|base}}|u=true}}
 
{{cpp/string/cvt str2int base|base={{c|base}}|u=true}}
  
−
If {{c|pos}} is not a null pointer, then ''{{c|ptr}}'' will receive the address of the first unconverted character in {{c|str.c_str()}}, and the index of that character will be calculated and stored in {{c|*pos}}, giving the number of characters that were processed by the conversion.
+
If {{c|pos}} is not a null pointer, then {{c|ptr}} will receive the address of the first unconverted character in {{c|str.c_str()}}, and the index of that character will be calculated and stored in {{c|*pos}}, giving the number of characters that were processed by the conversion.
  
 
===Parameters===
 
===Parameters===

Latest revision as of 21:43, 7 August 2023

 
C++
 
Strings library
 
std::basic_string
Member functions
(C++23)
Element access
(DR*)
(DR*)
(C++17)
Iterators
(C++11)
(C++11)
(C++11)
(C++11)
Capacity
(DR*)
Modifiers
(C++23)
(DR*)
(C++23)
(C++23)
(C++23)  
Search
Operations
(C++20)
(C++20)
(C++23)
Constants
Non-member functions
(C++20)(C++20)
I/O
Comparison
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)
Numeric conversions
(C++11)(C++11)(C++11)
stoulstoull
(C++11)(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Literals
(C++14)
Helper classes
(C++11)
Deduction guides (C++17)

 
Defined in header <string>
unsigned long      stoul ( const std::string& str,
                           std::size_t* pos = nullptr, int base = 10 );
 (1) (since C++11)
unsigned long      stoul ( const std::wstring& str,
                           std::size_t* pos = nullptr, int base = 10 );
 (2) (since C++11)
unsigned long long stoull( const std::string& str,
                           std::size_t* pos = nullptr, int base = 10 );
 (3) (since C++11)
unsigned long long stoull( const std::wstring& str,
                           std::size_t* pos = nullptr, int base = 10 );
 (4) (since C++11)

Interprets an unsigned integer value in the string str.

Let ptr be an internal (to the conversion functions) pointer of type char* (1,3) or wchar_t* (2,4), accordingly.

1) Calls std::strtoul(str.c_str(), &ptr, base).
2) Calls std::wcstoul(str.c_str(), &ptr, base).
3) Calls std::strtoull(str.c_str(), &ptr, base).
4) Calls std::wcstoull(str.c_str(), &ptr, base).

Discards any whitespace characters (as identified by calling std::isspace) until the first non-whitespace character is found, then takes as many characters as possible to form a valid base-n (where n=base) unsigned integer number representation and converts them to an integer value. The valid unsigned 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 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.

Additional numeric formats may be accepted by the currently installed C locale.

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 the minus sign was part of the input sequence, the numeric value calculated from the sequence of digits is negated as if by unary minus in the result type, which applies unsigned integer wraparound rules.

If pos is not a null pointer, then ptr will receive the address of the first unconverted character in str.c_str(), and the index of that character will be calculated and stored in *pos, giving the number of characters that were processed by the conversion.

Contents

[edit] Parameters

str - the string to convert
pos - address of an integer to store the number of characters processed
base - the number base

[edit] Return value

The string converted to the specified unsigned integer type.

[edit] Exceptions

[edit] Example

This section is incomplete
Reason: no example

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 2009 C++11 std::out_of_range would not be thrown if
std::strtoul or std::strtoull sets errno to ERANGE 		will throw

[edit] See also

(C++11)(C++11)(C++11)
 converts a string to a signed integer
(function) [edit]
(C++11)(C++11)(C++11)
 converts a string to a floating point value
(function) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/string/basic_string/stoul&oldid=156406"