libexplain/getrusage_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/resource.h>
#include <libexplain/getrusage.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_getrusage_or_die (int who, struct rusage *usage)
int	explain_getrusage_on_error (int who, struct rusage *usage)

---

Function Documentation

int explain_getrusage_on_error	(	int	who,
		struct rusage *	usage
	)

The explain_getrusage_on_error function is used to call the getrusage(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_getrusage(3) function.

Parameters:

who	The who, exactly as to be passed to the getrusage(2) system call.
usage	The usage, exactly as to be passed to the getrusage(2) system call.

Returns:

The value returned by the wrapped getrusage(2) system call.

Example:

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

 if (explain_getrusage_on_error(who, usage) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file getrusage_or_die.c.

void explain_getrusage_or_die	(	int	who,
		struct rusage *	usage
	)

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

Parameters:

who	The who, exactly as to be passed to the getrusage(2) system call.
usage	The usage, exactly as to be passed to the getrusage(2) system call.

Returns:

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

 explain_getrusage_or_die(who, usage);

Definition at line 27 of file getrusage_or_die.c.