libexplain/message/strtod.c File Reference

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

Go to the source code of this file.

Functions
void	explain_message_strtod (char *message, int message_size, const char *nptr, char **endptr)

---

Function Documentation

void explain_message_strtod	(	char *	message,
		int	message_size,
		const char *	nptr,
		char **	endptr
	)

The explain_message_strtod function is used to obtain an explanation of an error returned by the strtod(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
nptr	The original nptr, exactly as passed to the strtod(3) system call.
endptr	The original endptr, exactly as passed to the strtod(3) system call.

Example:

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

 double result = strtod(nptr, endptr);
 if (result < 0)
 {
     char message[3000];
     explain_message_strtod(message, sizeof(message), nptr, endptr);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_strtod_or_die function.

Definition at line 25 of file strtod.c.