wcstoul(), wcstoull()

Convert a wide-character string into an unsigned long integer

Synopsis:

#include <wchar.h>

unsigned long wcstoul( const wchar_t * ptr,
                       wchar_t ** endptr,
                       int base );

unsigned long long wcstoull( const wchar_t * ptr,
                             wchar_t ** endptr,
                             int base );

Since:

BlackBerry 10.0.0

Arguments:

ptr
A pointer to the string to parse.
endptr
If this argument isn't NULL, the function stores in it a pointer to the first unrecognized character found in the string.
base
The base of the number being parsed:
  • If base is zero, the first characters after the optional sign determine the base used for the conversion. If the first characters are 0x or 0X the digits are treated as hexadecimal. If the first character is 0, the digits are treated as octal. Otherwise, the digits are treated as decimal.
  • If base isn't zero, it must have a value between 2 and 36. The letters a-z and A-Z represent the values 10 through 35. Only those letters whose designated values are less than base are permitted. If the value of base is 16, the characters 0x or 0X may optionally precede the sequence of letters and digits.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

These functions convert a wide-character string into a number:

  • wcstoul() converts the string into an unsigned long
  • wcstoull() converts it into a unsigned long long.

These functions recognize a string containing optional white space, followed by a sequence of digits and letters. The conversion ends at the first unrecognized character. A pointer to that character is stored in the object endptr points to, if endptr isn't NULL.

If base is zero, the first characters determine the base used for the conversion. If the first characters are 0x or 0X the digits are treated as hexadecimal. If the first character is 0, the digits are treated as octal. Otherwise, the digits are treated as decimal.

If base isn't zero, it must have a value of between 2 and 36. The letters a-z and A-Z represent the values 10 through 35. Only those letters whose designated values are less than base are permitted. If the value of base is 16, the characters 0x or 0X may optionally precede the sequence of letters and digits.

Returns:

The converted value.

If the correct value causes an overflow, ULONG_MAX|ULONGLONG_MAX is returned and errno is set to ERANGE. If base is out of range, zero is returned and errno is set to EDOM.

Errors:

ERANGE
The value is not representable
EINVAL
The value for base is not supported or no conversion could be performed.

Classification:

ANSI, POSIX 1003.1

Safety:  
Cancellation point No
Interrupt handler Yes
Signal handler Yes
Thread Yes

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus