libexplain/strtoul_or_die.c File Reference

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

Go to the source code of this file.

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

---

Function Documentation

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

The explain_strtoul_or_die 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, and then the process terminates by calling exit(EXIT_FAILURE).

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:

This function only returns on success, see strtoul(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:

 unsigned long result = explain_strtoul_or_die(nptr, endptr, base);

Definition at line 26 of file strtoul_or_die.c.