NAME¶

SDL_wcstoul - Parse an unsigned long from a wide string.

SYNOPSIS¶

#include <SDL3/SDL_stdinc.h>

unsigned long SDL_wcstoul(const wchar_t *str, wchar_t **endp, int base);

DESCRIPTION¶

If str starts with whitespace, then those whitespace characters are skipped before attempting to parse the number.

If the parsed number does not fit inside an unsigned long, the result is clamped to the minimum and maximum representable unsigned long values.

FUNCTION PARAMETERS¶

str

The null-terminated wide string to read. Must not be NULL.

endp

If not NULL, the address of the first invalid wide character (i.e. the next character after the parsed number) will be written to this pointer.

base

The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. If 0, the base will be inferred from the number's prefix (0x for hexadecimal, 0 for octal, decimal otherwise).

RETURN VALUE¶

Returns the parsed unsigned long, or 0 if no number could be parsed.

THREAD SAFETY¶

It is safe to call this function from any thread.

AVAILABILITY¶

This function is available since SDL 3.6.0.

SEE ALSO¶

SDL_strtoul(3)