libexplain  1.4.D001
Functions
libexplain/getgroups_or_die.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/getgroups.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions

int explain_getgroups_on_error (int data_size, gid_t *data)
int explain_getgroups_or_die (int data_size, gid_t *data)

Function Documentation

int explain_getgroups_on_error ( int  data_size,
gid_t *  data 
)

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

Parameters:
data_sizeThe data_size, exactly as to be passed to the getgroups(2) system call.
dataThe data, exactly as to be passed to the getgroups(2) system call.
Returns:
The value returned by the wrapped getgroups(2) system call.
Example:
This function is intended to be used in a fashion similar to the following example:
 if (explain_getgroups_on_error(data_size, data) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file getgroups_or_die.c.

int explain_getgroups_or_die ( int  data_size,
gid_t *  data 
)

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

Parameters:
data_sizeThe data_size, exactly as to be passed to the getgroups(2) system call.
dataThe data, exactly as to be passed to the getgroups(2) system call.
Returns:
This function only returns on success, see getgroups(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_getgroups_or_die(data_size, data);

Definition at line 46 of file getgroups_or_die.c.