wcstold

Converts a wide-character string to a long double value.

Library:LibC
Classification:ANSI
Service:Characters and Strings

Syntax

  #include <wchar.h> 
   
  long double   wcstold (
     const wchar_t   *nptr,
     wchar_t        **endptr);
  

Parameters

ptr

(IN) Points to the wide-character string to be converted.

endptr

(OUT) Points to the first unrecognized character.

Return Values

If successful, returns the converted value. Otherwise, returns one of the following:

  • If the correct value would cause overflow, returns plus or minus HUGE_VALL and sets errno to ERANGE. The sign of HUGE_VALL matches the sign of the value that cannot be represented.

  • If the correct value causes underflow, returns a value whose magnitude is no greater than the smallest normalized positive number and sets errno to ERANGE.

  • If no conversion can be performed, returns 0 and sets errno to EINVAL.

Remarks

The wcstold function converts the string pointed to by nptr to an object of type long double. The function recognizes a string containing:

  • Optional whitespace characters

  • An optional plus (+) or minus (-) sign

  • A sequence of digits and letters

The conversion ends at the first unrecognized character. A pointer to that character is stored in the object to which endptr points if endptr is not NULL.

The base parameter must have a value between 2 and 36. The letters a through z and A through 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 can optionally precede the sequence of letters and digits.

See Also

wcstod