strtoumax, _strtoumax_l, wcstoumax, _wcstoumax_l

Article
06/05/2017

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at strtoumax, _strtoumax_l, wcstoumax, _wcstoumax_l.

Converts strings to an integer value of the largest supported unsigned integer type.

Syntax

uintmax_t strtoumax(  
   const char *nptr,  
   char **endptr,  
   int base   
);  
uintmax_t _strtoumax_l(  
   const char *nptr,  
   char **endptr,  
   int base,  
   _locale_t locale  
);  
uintmax_t wcstoumax(  
   const wchar_t *nptr,  
   wchar_t **endptr,  
   int base   
);  
uintmax_t _wcstoumax_l(  
   const wchar_t *nptr,  
   wchar_t **endptr,  
   int base,  
   _locale_t locale  
);

Parameters

nptr
Null-terminated string to convert.

endptr
Pointer to the character that stops the scan.

base
Number base to use.

locale
Locale to use.

Return Value

strtoumax returns the converted value, if any, or UINTMAX_MAX on overflow. strtoumax returns 0 if no conversion can be performed. wcstoumax returns values analogously to strtoumax. For both functions, errno is set to ERANGE if overflow or underflow occurs.

For more information about return codes, see errno, _doserrno, _sys_errlist, and _sys_nerr.

Remarks

Each of these functions converts the input string nptr to a uintmax_t integer value.

strtoumax stops reading the string nptr at the first character it cannot recognize as part of a number. This may be the terminating null character, or it may be the first numeric character that's greater than or equal to base. The LC_NUMERIC category setting of the locale determines the recognition of the radix character in nptr. For more information, see setlocale, _wsetlocale. strtoumax and wcstoumax use the current locale; _strtoumax_l and _wcstoumax_l are identical except that they instead use the locale that's passed in. For more information, see Locale.

If endptr is not NULL, a pointer to the character that stopped the scan is stored at the location that's pointed to by endptr. If no conversion can be performed (no valid digits were found or an invalid base was specified), the value of nptr is stored at the location that's pointed to by endptr.

The wide-character version of strtoumax is wcstoumax; its nptr argument is a wide-character string. Otherwise, these functions behave identically.

Generic-Text Routine Mappings

TCHAR.H routine	_UNICODE & _MBCS not defined	_MBCS defined	_UNICODE defined
`_tcstoumax`	`strtoumax`	`strtoumax`	`wcstoumax`
`_tcstoumax_l`	`strtoumax_l`	`_strtoumax_l`	`_wcstoumax_l`

strtoumax expects nptr to point to a string of the following form:

[whitespace] [{+ | –}] [0 [{ x | X }]] [digits | [letters]]

A whitespace may consist of space and tab characters, which are ignored; digits are one or more decimal digits; letters are one or more of the letters 'a' through 'z' (or 'A' through 'Z'). The first character that does not fit this form stops the scan. If base is between 2 and 36, then it is used as the base of the number. If base is 0, the initial characters of the string that's pointed to by nptr are used to determine the base. If the first character is '0' and the second character is not 'x' or 'X', the string is interpreted as an octal integer. If the first character is '0' and the second character is 'x' or 'X', the string is interpreted as a hexadecimal integer. If the first character is '1' through '9', the string is interpreted as a decimal integer. The letters 'a' through 'z' (or 'A' through 'Z') are assigned the values 10 through 35; only letters whose assigned values are less than base are permitted. The first character outside the range of the base stops the scan. For example, if base is 0 and the first character scanned is '0', an octal integer is assumed and an '8' or '9' character would stop the scan. strtoumax allows a plus sign (+) or minus sign (–) prefix; a leading minus sign indicates that the return value is the two’s complement of the absolute value of the converted string.

Requirements

Routine	Required header
`strtoumax`	<stdlib.h>
`wcstoumax`	<stdlib.h> or <wchar.h>
`_strtoumax_l`	<stdlib.h>
`_wcstoumax_l`	<stdlib.h> or <wchar.h>

For additional compatibility information, see Compatibility.

Example

See the example for strtod.

.NET Framework Equivalent

System::Convert::ToUInt64

Share via