libexplain/buffer/errno/getgrouplist.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/getgrouplist.h>
#include <libexplain/buffer/gid.h>
#include <libexplain/buffer/int.h>
#include <libexplain/buffer/pathname.h>
#include <libexplain/buffer/pointer.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_getgrouplist_system_call (explain_string_buffer_t *sb, int errnum, const char *user, gid_t group, gid_t *groups, int *ngroups)
void	explain_buffer_errno_getgrouplist_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *user, gid_t group, gid_t *groups, int *ngroups)
void	explain_buffer_errno_getgrouplist (explain_string_buffer_t *sb, int errnum, const char *user, gid_t group, gid_t *groups, int *ngroups)

---

Function Documentation

void explain_buffer_errno_getgrouplist	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	user,
		gid_t	group,
		gid_t *	groups,
		int *	ngroups
	)

The explain_buffer_errno_getgrouplist function is used to obtain an explanation of an error returned by the getgrouplist(3) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
user	The original user, exactly as passed to the getgrouplist(3) system call.
group	The original group, exactly as passed to the getgrouplist(3) system call.
groups	The original groups, exactly as passed to the getgrouplist(3) system call.
ngroups	The original ngroups, exactly as passed to the getgrouplist(3) system call.

Definition at line 82 of file getgrouplist.c.

void explain_buffer_errno_getgrouplist_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	user,
		gid_t	group,
		gid_t *	groups,
		int *	ngroups
	)

The explain_buffer_errno_getgrouplist_explanation function is used to obtain the explanation (the part after "because") of an error returned by the getgrouplist(3) system call (and similar).

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
syscall_name	The name of the offending system call.
user	The original user, exactly as passed to the getgrouplist(3) system call.
group	The original group, exactly as passed to the getgrouplist(3) system call.
groups	The original groups, exactly as passed to the getgrouplist(3) system call.
ngroups	The original ngroups, exactly as passed to the getgrouplist(3) system call.

Definition at line 48 of file getgrouplist.c.

static void explain_buffer_errno_getgrouplist_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	user,
		gid_t	group,
		gid_t *	groups,
		int *	ngroups
	)		[static]

Definition at line 31 of file getgrouplist.c.