libexplain/strtol_on_error.c File Reference

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

Go to the source code of this file.

Functions
long	explain_strtol_on_error (const char *nptr, char **endptr, int base)

---

Function Documentation

long explain_strtol_on_error	(	const char *	nptr,
		char **	endptr,
		int	base
	)

The explain_strtol_on_error function is used to call the strtol(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strtol(3) function.

Parameters:

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

Returns:

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

Example:

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

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

Definition at line 27 of file strtol_on_error.c.