std::wcstoimax, std::wcstoumax

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Strings library

Null-terminated strings

Byte strings

Multibyte strings

Wide strings

Classes

basic_string

char_traits

 

Null-terminated wide strings

Functions
Character manipulation
iswalnum iswalpha iswlower iswupper iswdigit iswxdigit iswblank (C++11) wctype iswctype	iswcntrl iswgraph iswspace iswprint iswpunct towlower towupper wctrans towctrans
Conversions to numeric formats
wcstolwcstoll wcstoulwcstoull	wcstofwcstodwcstold wcstoimaxwcstouimax (C++11)(C++11)
String manipulation
wcslen wcscpy wcsncpy wcscat wcsncat wcscmp wcscoll wcsncmp	wcsxfrm wcschr wcsrchr wcspbrk wcsspn wcscspn wcsstr wcstok
Array manipulation
wmemcpy
wmemmove
wmemcmp
wmemchr
wmemset

 

Defined in header <cinttypes>
std::intmax_t wcstoimax( const wchar_t* nptr, wchar_t** endptr, int base );		(since C++11)
std::uintmax_t wcstoumax( const wchar_t* nptr, wchar_t** endptr, int base );		(since C++11)

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

Discards any whitespace characters (as identified by calling 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) 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.

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 in the result type.

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

Parameters

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

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 and INTMAX_MAX, INTMAX_MIN, UINTMAX_MAX, or ​0​ is returned, as appropriate. If no conversion can be performed, ​0​ is returned.

Example

Run this code

#include <iostream>
#include <string>
#include <cinttypes>
 
int main()
{
    std::wstring str = L"helloworld";
    std::intmax_t val = std::wcstoimax(str.c_str(), nullptr, 36);
    std::wcout << str << " in base 36 is " << val << " in base 10\n";
 
    wchar_t* nptr;
    val = std::wcstoimax(str.c_str(), &nptr, 30);
    if(nptr != &str[0] + str.size())
        std::wcout << str << " in base 30 is invalid."
                  << " The first invalid digit is " << *nptr << '\n';
}

Output:

helloworld in base 36 is 1767707668033969 in base 10
helloworld in base 30 is invalid. The first invalid digit is w

See also

strtoimaxstrtoumax (C++11)(C++11)	converts a byte string to std::intmax_t or std::uintmax_t (function)
wcstolwcstoll	converts a wide string to an integer value (function)
wcstoulwcstoull	converts a wide string to an unsigned integer value (function)
C documentation for wcstoimax, wcstoumax