libexplain/buffer/errno/getresgid.h File Reference

#include <libexplain/ac/unistd.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_getresgid (explain_string_buffer_t *sb, int errnum, gid_t *rgid, gid_t *egid, gid_t *sgid)
void	explain_buffer_errno_getresgid_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, gid_t *rgid, gid_t *egid, gid_t *sgid)

---

Function Documentation

void explain_buffer_errno_getresgid	(	explain_string_buffer_t *	sb,
		int	errnum,
		gid_t *	rgid,
		gid_t *	egid,
		gid_t *	sgid
	)

The explain_buffer_errno_getresgid function is used to obtain an explanation of an error returned by the getresgid(2) 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.
rgid	The original rgid, exactly as passed to the getresgid(2) system call.
egid	The original egid, exactly as passed to the getresgid(2) system call.
sgid	The original sgid, exactly as passed to the getresgid(2) system call.

Definition at line 79 of file getresgid.c.

void explain_buffer_errno_getresgid_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		gid_t *	rgid,
		gid_t *	egid,
		gid_t *	sgid
	)

The explain_buffer_errno_getresgid_explanation function is used to obtain the explanation (the part after "because") of an error returned by the getresgid(2) 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.
rgid	The original rgid, exactly as passed to the getresgid(2) system call.
egid	The original egid, exactly as passed to the getresgid(2) system call.
sgid	The original sgid, exactly as passed to the getresgid(2) system call.

Definition at line 45 of file getresgid.c.