libexplain/setregid_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setregid_or_die (gid_t rgid, gid_t egid)
int	explain_setregid_on_error (gid_t rgid, gid_t egid)

---

Function Documentation

int explain_setregid_on_error	(	gid_t	rgid,
		gid_t	egid
	)

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

Parameters:

rgid	The rgid, exactly as to be passed to the setregid(2) system call.
egid	The egid, exactly as to be passed to the setregid(2) system call.

Returns:

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

Example:

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

 if (explain_setregid_on_error(rgid, egid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file setregid_or_die.c.

void explain_setregid_or_die	(	gid_t	rgid,
		gid_t	egid
	)

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

Parameters:

rgid	The rgid, exactly as to be passed to the setregid(2) system call.
egid	The egid, exactly as to be passed to the setregid(2) system call.

Returns:

This function only returns on success, see setregid(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_setregid_or_die(rgid, egid);

Definition at line 27 of file setregid_or_die.c.