strtold

Convert ASCII string to floating point

View other versions (4)

Contents

Interface
Description
Return Values
Errors
Standards
See Also
Bugs
Page Comments

Interface

#include <stdlib.h>
double  strtod (const char * restrict nptr, char ** restrict endptr)
float  strtof (const char * restrict nptr, char ** restrict endptr)
long double  strtold (const char * restrict nptr, char ** restrict endptr)

Description

These conversion functions convert the initial portion of the string pointed to by nptr to double, float, and long double representation, respectively.

The expected form of the string is an optional plus ("+") or minus sign ("-") followed by either:

a decimal significand consisting of a sequence of decimal digits optionally containing a decimal-point character, or
a hexadecimal significand consisting of a "0X" or "0x" followed by a sequence of hexadecimal digits optionally containing a decimal-point character.

In both cases, the significand may be optionally followed by an exponent. An exponent consists of an "E" or "e" (for decimal constants) or a "P" or "p" (for hexadecimal constants), followed by an optional plus or minus sign, followed by a sequence of decimal digits. For decimal constants, the exponent indicates the power of 10 by which the significand should be scaled. For hexadecimal constants, the scaling is instead done by powers of 2.

Alternatively, if the portion of the string following the optional plus or minus sign begins with "INFINITY" or "NAN", ignoring case, it is interpreted as an infinity or a quiet NaN, respectively.

In any of the above cases, leading white-space characters in the string (as defined by the isspace function) are skipped. The decimal point character is defined in the program's locale (category LC_NUMERIC).

Extended locale versions of these functions are documented in strtod_l. See xlocale for more information.

Example 1

#include <stdio.h>
#include <stdlib.h>
 
int main ()
{
  char number[10] = "3.141592", *end;
  double pi = strtod(number, &end);
  printf("pi = %lf\n", pi);
  return 0;
}

Output:

pi = 3.141592

Return Values

The strtod, strtof and strtold functions return the converted value, if any.

If endptr is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.

If no conversion is performed, zero is returned and the value of nptr is stored in the location referenced by endptr.

If the correct value would cause overflow, plus or minus HUGE_VAL, HUGE_VALF, or HUGE_VALL is returned (according to the sign and type of the return value), and ERANGE is stored in errno. If the correct value would cause underflow, zero is returned and ERANGE is stored in errno.

Errors

[ERANGE]

Overflow or underflow occurred.

Standards

The strtod function conforms to ISO/IEC 9899:1999 ("ISO C99"), with the exception of the bug noted below.

Bugs

These routines do not recognize the C99 "NaN(...)" syntax.

double	`strtod` (const char * restrict nptr, char ** restrict endptr)
float	`strtof` (const char * restrict nptr, char ** restrict endptr)
long double	`strtold` (const char * restrict nptr, char ** restrict endptr)