libexplain/getresgid_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_getresgid_or_die (gid_t *rgid, gid_t *egid, gid_t *sgid)
int	explain_getresgid_on_error (gid_t *rgid, gid_t *egid, gid_t *sgid)

---

Function Documentation

int explain_getresgid_on_error	(	gid_t *	rgid,
		gid_t *	egid,
		gid_t *	sgid
	)

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

Parameters:

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

Returns:

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

Example:

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

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

Definition at line 37 of file getresgid_or_die.c.

void explain_getresgid_or_die	(	gid_t *	rgid,
		gid_t *	egid,
		gid_t *	sgid
	)

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

Parameters:

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

Returns:

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

Definition at line 27 of file getresgid_or_die.c.