libexplain/buffer/errno/fchownat.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_fchownat (explain_string_buffer_t *sb, int errnum, int dirfd, const char *pathname, int owner, int group, int flags)
void	explain_buffer_errno_fchownat_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int dirfd, const char *pathname, int owner, int group, int flags)

---

Function Documentation

void explain_buffer_errno_fchownat	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	dirfd,
		const char *	pathname,
		int	owner,
		int	group,
		int	flags
	)

The explain_buffer_errno_fchownat function is used to obtain an explanation of an error returned by the fchownat(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.
dirfd	The original dirfd, exactly as passed to the fchownat(2) system call.
pathname	The original pathname, exactly as passed to the fchownat(2) system call.
owner	The original owner, exactly as passed to the fchownat(2) system call.
group	The original group, exactly as passed to the fchownat(2) system call.
flags	The original flags, exactly as passed to the fchownat(2) system call.

Definition at line 143 of file fchownat.c.

void explain_buffer_errno_fchownat_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	dirfd,
		const char *	pathname,
		int	owner,
		int	group,
		int	flags
	)

The explain_buffer_errno_fchownat_explanation function is used to obtain the explanation (the part after "because") of an error returned by the fchownat(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.
dirfd	The original dirfd, exactly as passed to the fchownat(2) system call.
pathname	The original pathname, exactly as passed to the fchownat(2) system call.
owner	The original owner, exactly as passed to the fchownat(2) system call.
group	The original group, exactly as passed to the fchownat(2) system call.
flags	The original flags, exactly as passed to the fchownat(2) system call.

Definition at line 61 of file fchownat.c.