libexplain/strtod_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdlib.h>
#include <libexplain/strtod.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
double	explain_strtod_on_error (const char *nptr, char **endptr)

---

Function Documentation

double explain_strtod_on_error	(	const char *	nptr,
		char **	endptr
	)

The explain_strtod_on_error function is used to call the strtod(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strtod(3) function.

Parameters:

nptr	The nptr, exactly as to be passed to the strtod(3) system call.
endptr	The endptr, exactly as to be passed to the strtod(3) system call.

Returns:

The value returned by the wrapped strtod(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 double result = explain_strtod_on_error(nptr, endptr);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file strtod_on_error.c.