libexplain/strtold.h File Reference

explain strtold(3) errors More...

#include <libexplain/gcc_attributes.h>

Go to the source code of this file.

Functions
long double	explain_strtold_or_die (const char *nptr, char **endptr) LIBEXPLAIN_WARN_UNUSED_RESULT
long double	explain_strtold_on_error (const char *nptr, char **endptr) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_strtold (const char *nptr, char **endptr) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_strtold (int errnum, const char *nptr, char **endptr) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_strtold (char *message, int message_size, const char *nptr, char **endptr)
void	explain_message_errno_strtold (char *message, int message_size, int errnum, const char *nptr, char **endptr)

---

Detailed Description

explain strtold(3) errors

These functions may be used to obtain explanations for errors returned by the strtold(3) system call.

Definition in file strtold.h.

---

Function Documentation

const char* explain_errno_strtold	(	int	errnum,
		const char *	nptr,
		char **	endptr
	)

The explain_errno_strtold function is used to obtain an explanation of an error returned by the strtold(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.

Parameters:

errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
nptr	The original nptr, exactly as passed to the strtold(3) system call.
endptr	The original endptr, exactly as passed to the strtold(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 long double result = strtold(nptr, endptr);
 if (result < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_strtold(err, nptr, endptr));
     exit(EXIT_FAILURE);
 }

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

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

The explain_message_errno_strtold function is used to obtain an explanation of an error returned by the strtold(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.

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.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
nptr	The original nptr, exactly as passed to the strtold(3) system call.
endptr	The original endptr, exactly as passed to the strtold(3) system call.

Example:

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

 long double result = strtold(nptr, endptr);
 if (result < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_strtold(message, sizeof(message), err, nptr,
         endptr);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

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

The explain_message_strtold function is used to obtain an explanation of an error returned by the strtold(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 strtold(3) system call.
endptr	The original endptr, exactly as passed to the strtold(3) system call.

Example:

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

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

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

const char* explain_strtold	(	const char *	nptr,
		char **	endptr
	)

The explain_strtold function is used to obtain an explanation of an error returned by the strtold(3) system call. The least the message will contain is the value of strerror(errno), 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:

nptr	The original nptr, exactly as passed to the strtold(3) system call.
endptr	The original endptr, exactly as passed to the strtold(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 long double result = strtold(nptr, endptr);
 if (result < 0)
 {
     fprintf(stderr, "%s\n", explain_strtold(nptr, endptr));
     exit(EXIT_FAILURE);
 }

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

long double explain_strtold_on_error	(	const char *	nptr,
		char **	endptr
	)

The explain_strtold_on_error function is used to call the strtold(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strtold(3) function.

Parameters:

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

Returns:

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

Example:

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

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

long double explain_strtold_or_die	(	const char *	nptr,
		char **	endptr
	)

The explain_strtold_or_die function is used to call the strtold(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strtold(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

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

Returns:

This function only returns on success, see strtold(3) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 long double result = explain_strtold_or_die(nptr, endptr);