Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/string/byte/strtoul"

From cppreference.com
< cpp‎ | string‎ | byte
m (Update links.)
m (char * -> char*)
 
(18 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
{{cpp/title| strtoul | strtoull}}
+
{{cpp/title|strtoul|strtoull}}
 
{{cpp/string/byte/navbar}}
 
{{cpp/string/byte/navbar}}
 
{{dcl begin}}
 
{{dcl begin}}
−
{{dcl header | cstdlib}}
+
{{dcl header|cstdlib}}
−
{{dcl |  
+
{{dcl|num=1|
−
unsigned long      strtoul( const char *str, char **str_end, int base );
+
unsigned long      strtoul ( const char* str, char** str_end, int base );
 
}}
 
}}
−
{{dcl | notes={{mark since c++11}} |
+
{{dcl|since=c++11|num=2|
−
unsigned long long strtoull( const char *str, char **str_end, int base );
+
unsigned long long strtoull( const char* str, char** str_end, int base );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
Interprets an unsigned integer value in a byte string pointed to by {{tt|str}}.
+
Interprets an unsigned integer value in a byte string pointed to by {{c|str}}.
  
−
{{cpp/string/cvt str2int base | base=base | u=true}}
+
{{cpp/string/cvt str2int base|base=base|u=true}}
  
−
The functions sets the pointer pointed to by {{tt|str_end}} to point to the character past the last character interpreted. If {{tt|str_end}} is {{lc|NULL}}, it is ignored.
+
The functions sets the pointer pointed to by {{c|str_end}} to point to the character past the last character interpreted. If {{c|str_end}} is a null pointer, it is ignored.
  
 
===Parameters===
 
===Parameters===
 
{{par begin}}
 
{{par begin}}
−
{{par | str | pointer to the null-terminated byte string to be interpreted}}
+
{{par|str|pointer to the null-terminated byte string to be interpreted}}
−
{{par | str_end | pointer to a pointer to character.}}
+
{{par|str_end|pointer to a pointer to character, might be set to a position past the last character interpreted}}
−
{{par | base | ''base'' of the interpreted integer value}}
+
{{par|base|''base'' of the interpreted integer value}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
−
Integer value corresponding to the contents of {{tt|str}} on success. If the converted value falls out of range of corresponding return type, range error occurs and {{lc|ULONG_MAX}} or {{lc|ULLONG_MAX}} is returned. If no conversion can be performed, {{c|0}} is returned.
+
Integer value corresponding to the contents of {{c|str}} on success. If the converted value falls out of range of corresponding return type, range error occurs ({{lc|errno}} is set to {{tt|ERANGE}}) and {{lc|ULONG_MAX}} or {{lc|ULLONG_MAX}} is returned. If no conversion can be performed, {{c|0}} is returned.
  
 
===Example===
 
===Example===
 
{{example
 
{{example
−
|
+
|code=
−
| code=
+
#include <cstdlib>
−
| output=
+
#include <errno.h>
 +
#include <iostream>
 +
#include <string>
 +
 
 +
int main()
 +
{
 +
    const char* p = "10 200000000000000000000000000000 30 -40 - 42";
 +
    char* end = nullptr;
 +
    std::cout << "Parsing '" << p << "':\n";
 +
    for (unsigned long i = std::strtoul(p, &end, 10);
 +
        p != end;
 +
        i = std::strtoul(p, &end, 10))
 +
    {
 +
        std::cout << "'" << std::string(p, end - p) << "' -> ";
 +
        p = end;
 +
        if (errno == ERANGE)
 +
        {
 +
            errno = 0;
 +
            std::cout << "range error, got ";
 +
        }
 +
        std::cout << i << '\n';
 +
    }
 +
    std::cout << "After the loop p points to '" << p << "'\n";
 +
}
 +
|p=true
 +
|output=
 +
Parsing '10 200000000000000000000000000000 30 -40 - 42':
 +
'10' -> 10
 +
' 200000000000000000000000000000' -> range error, got 18446744073709551615
 +
' 30' -> 30
 +
' -40' -> 18446744073709551576
 +
After the loop p points to ' - 42'
 
}}
 
}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
−
{{dsc inc | cpp/string/byte/dsc atoi}}
+
{{dsc inc|cpp/string/basic_string/dsc stoul}}
−
{{dsc inc | cpp/string/byte/dsc strtol}}
+
{{dsc inc|cpp/string/byte/dsc strtol}}
−
{{dsc see c | c/string/byte/strtoul | strtoul | strtoull}}
+
{{dsc inc|cpp/string/byte/dsc strtoimax}}
 +
{{dsc inc|cpp/string/wide/dsc wcstoul}}
 +
{{dsc inc|cpp/string/byte/dsc strtof}}
 +
{{dsc inc|cpp/utility/dsc from_chars}}
 +
{{dsc inc|cpp/string/byte/dsc atoi}}
 +
{{dsc see c|c/string/byte/strtoul|strtoul|strtoull}}
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:cpp/string/byte/strtoul]]
+
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
−
[[es:cpp/string/byte/strtoul]]
+
−
[[fr:cpp/string/byte/strtoul]]
+
−
[[it:cpp/string/byte/strtoul]]
+
−
[[ja:cpp/string/byte/strtoul]]
+
−
[[pt:cpp/string/byte/strtoul]]
+
−
[[ru:cpp/string/byte/strtoul]]
+
−
[[zh:cpp/string/byte/strtoul]]
+

Latest revision as of 23:05, 21 October 2023

 
C++
 
Strings library
 
Null-terminated byte strings
Functions
Character manipulation
Conversions to numeric formats
strtoulstrtoull
(C++11)
(C++11)(C++11)
(C++11)(C++11)
String manipulation
String examination
Memory manipulation
Miscellaneous
 
Defined in header <cstdlib>
unsigned long      strtoul ( const char* str, char** str_end, int base );
 (1)
unsigned long long strtoull( const char* str, char** str_end, int base );
 (2) (since C++11)

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

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.

The functions sets the pointer pointed to by str_end to point to the character past the last character interpreted. If str_end is a null pointer, it is ignored.

Contents

[edit] Parameters

str - pointer to the null-terminated byte string to be interpreted
str_end - pointer to a pointer to character, might be set to a position past the last character interpreted
base - base of the interpreted integer value

[edit] Return value

Integer value corresponding to the contents of str on success. If the converted value falls out of range of corresponding return type, range error occurs (errno is set to ERANGE) and ULONG_MAX or ULLONG_MAX is returned. If no conversion can be performed, ​0​ is returned.

[edit] Example

Run this code
#include <cstdlib>
#include <errno.h>
#include <iostream>
#include <string>
 
int main()
{
    const char* p = "10 200000000000000000000000000000 30 -40 - 42";
    char* end = nullptr;
    std::cout << "Parsing '" << p << "':\n";
    for (unsigned long i = std::strtoul(p, &end, 10);
        p != end;
        i = std::strtoul(p, &end, 10))
    {
        std::cout << "'" << std::string(p, end - p) << "' -> ";
        p = end;
        if (errno == ERANGE)
        {
            errno = 0;
            std::cout << "range error, got ";
        }
        std::cout << i << '\n';
    }
    std::cout << "After the loop p points to '" << p << "'\n";
}

Possible output: 

Parsing '10 200000000000000000000000000000 30 -40 - 42':
'10' -> 10
' 200000000000000000000000000000' -> range error, got 18446744073709551615
' 30' -> 30
' -40' -> 18446744073709551576
After the loop p points to ' - 42'

[edit] See also

(C++11)(C++11)
 converts a string to an unsigned integer
(function) [edit]
(C++11)
 converts a byte string to an integer value
(function) [edit]
(C++11)(C++11)
 converts a byte string to std::intmax_t or std::uintmax_t
(function) [edit]
converts a wide string to an unsigned integer value
(function) [edit]
converts a byte string to a floating-point value
(function) [edit]
(C++17)
 converts a character sequence to an integer or floating-point value
(function) [edit]
(C++11)
 converts a byte string to an integer value
(function) [edit]
C documentation for strtoul, strtoull
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/string/byte/strtoul&oldid=161090"