libexplain/setreuid_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/output.h>
#include <libexplain/setreuid.h>

Go to the source code of this file.

Functions
void	explain_setreuid_or_die (uid_t ruid, uid_t euid)
int	explain_setreuid_on_error (uid_t ruid, uid_t euid)

---

Function Documentation

int explain_setreuid_on_error	(	uid_t	ruid,
		uid_t	euid
	)

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

Parameters:

ruid	The ruid, exactly as to be passed to the setreuid(2) system call.
euid	The euid, exactly as to be passed to the setreuid(2) system call.

Returns:

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

Example:

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

 if (explain_setreuid_on_error(ruid, euid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file setreuid_or_die.c.

void explain_setreuid_or_die	(	uid_t	ruid,
		uid_t	euid
	)

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

Parameters:

ruid	The ruid, exactly as to be passed to the setreuid(2) system call.
euid	The euid, exactly as to be passed to the setreuid(2) system call.

Returns:

This function only returns on success, see setreuid(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_setreuid_or_die(ruid, euid);

Definition at line 27 of file setreuid_or_die.c.