libexplain/buffer/errno/setresuid.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_setresuid (explain_string_buffer_t *sb, int errnum, uid_t ruid, uid_t euid, uid_t suid)
void	explain_buffer_errno_setresuid_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, uid_t ruid, uid_t euid, uid_t suid)

---

Function Documentation

void explain_buffer_errno_setresuid	(	explain_string_buffer_t *	sb,
		int	errnum,
		uid_t	ruid,
		uid_t	euid,
		uid_t	suid
	)

The explain_buffer_errno_setresuid function is used to obtain an explanation of an error returned by the setresuid(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.
ruid	The original ruid, exactly as passed to the setresuid(2) system call.
euid	The original euid, exactly as passed to the setresuid(2) system call.
suid	The original suid, exactly as passed to the setresuid(2) system call.

Definition at line 148 of file setresuid.c.

void explain_buffer_errno_setresuid_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		uid_t	ruid,
		uid_t	euid,
		uid_t	suid
	)

The explain_buffer_errno_setresuid_explanation function is used to obtain the explanation (the part after "because") of an error returned by the setresuid(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.
ruid	The original ruid, exactly as passed to the setresuid(2) system call.
euid	The original euid, exactly as passed to the setresuid(2) system call.
suid	The original suid, exactly as passed to the setresuid(2) system call.

Definition at line 75 of file setresuid.c.