libexplain/strtoul_on_error.c File Reference

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

Go to the source code of this file.

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

---

Function Documentation

unsigned long explain_strtoul_on_error	(	const char *	nptr,
		char **	endptr,
		int	base
	)

The explain_strtoul_on_error function is used to call the strtoul(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_strtoul(3) function.

Parameters:

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

Returns:

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

Example:

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

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

Definition at line 27 of file strtoul_on_error.c.