libexplain/getgrouplist_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/types.h>
#include <libexplain/ac/grp.h>
#include <libexplain/getgrouplist.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_getgrouplist_or_die (const char *user, gid_t group, gid_t *groups, int *ngroups)
int	explain_getgrouplist_on_error (const char *user, gid_t group, gid_t *groups, int *ngroups)

---

Function Documentation

int explain_getgrouplist_on_error	(	const char *	user,
		gid_t	group,
		gid_t *	groups,
		int *	ngroups
	)

The explain_getgrouplist_on_error function is used to call the getgrouplist(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_getgrouplist(3) function.

Parameters:

user	The user, exactly as to be passed to the getgrouplist(3) system call.
group	The group, exactly as to be passed to the getgrouplist(3) system call.
groups	The groups, exactly as to be passed to the getgrouplist(3) system call.
ngroups	The ngroups, exactly as to be passed to the getgrouplist(3) system call.

Returns:

The value returned by the wrapped getgrouplist(3) system call.

Example:

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

 errno = 0;
 if (explain_getgrouplist_on_error(user, group, groups, ngroups) < 0 && errno
     != 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 108 of file getgrouplist_or_die.c.

void explain_getgrouplist_or_die	(	const char *	user,
		gid_t	group,
		gid_t *	groups,
		int *	ngroups
	)

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

Parameters:

user	The user, exactly as to be passed to the getgrouplist(3) system call.
group	The group, exactly as to be passed to the getgrouplist(3) system call.
groups	The groups, exactly as to be passed to the getgrouplist(3) system call.
ngroups	The ngroups, exactly as to be passed to the getgrouplist(3) system call.

Returns:

This function only returns on success, see getgrouplist(3) 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_getgrouplist_or_die(user, group, groups, ngroups);

Definition at line 28 of file getgrouplist_or_die.c.