libexplain/setgid_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setgid_or_die (gid_t gid)
int	explain_setgid_on_error (gid_t gid)

---

Function Documentation

int explain_setgid_on_error

(

gid_t

gid

)

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

Parameters:

gid	The gid, exactly as to be passed to the setgid(2) system call.

Returns:

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

Example:

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

 if (explain_setgid_on_error(gid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file setgid_or_die.c.

void explain_setgid_or_die

(

gid_t

gid

)

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

Parameters:

gid	The gid, exactly as to be passed to the setgid(2) system call.

Returns:

This function only returns on success, see setgid(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_setgid_or_die(gid);

Definition at line 27 of file setgid_or_die.c.