libexplain/setpriority_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setpriority_or_die (int which, int who, int prio)
int	explain_setpriority_on_error (int which, int who, int prio)

---

Function Documentation

int explain_setpriority_on_error	(	int	which,
		int	who,
		int	prio
	)

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

Parameters:

which	The which, exactly as to be passed to the setpriority(2) system call.
who	The who, exactly as to be passed to the setpriority(2) system call.
prio	The prio, exactly as to be passed to the setpriority(2) system call.

Returns:

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

Example:

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

 if (explain_setpriority_on_error(which, who, prio) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file setpriority_or_die.c.

void explain_setpriority_or_die	(	int	which,
		int	who,
		int	prio
	)

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

Parameters:

which	The which, exactly as to be passed to the setpriority(2) system call.
who	The who, exactly as to be passed to the setpriority(2) system call.
prio	The prio, exactly as to be passed to the setpriority(2) system call.

Returns:

This function only returns on success, see setpriority(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_setpriority_or_die(which, who, prio);

Definition at line 27 of file setpriority_or_die.c.