explain_strtoul_or_die3
Convert string to unsigned long and report errors
Usage
#include <libexplain/strtoul.h>
unsigned long explain_strtoul_or_die(const char *nptr, char **endptr, int base);
unsigned long explain_strtoul_on_error(const char *nptr, char **endptr, int base))
Overview
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).
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, but still returns to the caller.
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. |
Return value
The explain_strtoul_or_die function only returns on success, see strtoul(3) for more information. On failure, prints an explanation and exits, it does not return.
The explain_strtoul_on_error function always returns the value return by the wrapped strtoul(3) system call.
Examples
The explain_strtoul_or_die function is intended to be used in a fashion similar to the following example:
unsigned long result = explain_strtoul_or_die(nptr, endptr, base);
Releases
6 releases since Debian 7 (Wheezy); the text changed 1 time.