libexplain/buffer/errno/lchownat.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_lchownat (explain_string_buffer_t *sb, int errnum, int fildes, const char *pathname, int uid, int gid)
void	explain_buffer_errno_lchownat_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int fildes, const char *pathname, int uid, int gid)

---

Function Documentation

void explain_buffer_errno_lchownat	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	fildes,
		const char *	pathname,
		int	uid,
		int	gid
	)

The explain_buffer_errno_lchownat function is used to obtain an explanation of an error returned by the lchownat(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.
fildes	The original fildes, exactly as passed to the lchownat(2) system call.
pathname	The original pathname, exactly as passed to the lchownat(2) system call.
uid	The original uid, exactly as passed to the lchownat(2) system call.
gid	The original gid, exactly as passed to the lchownat(2) system call.

Definition at line 134 of file lchownat.c.

void explain_buffer_errno_lchownat_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	fildes,
		const char *	pathname,
		int	uid,
		int	gid
	)

The explain_buffer_errno_lchownat_explanation function is used to obtain the explanation (the part after "because") of an error returned by the lchownat(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.
fildes	The original fildes, exactly as passed to the lchownat(2) system call.
pathname	The original pathname, exactly as passed to the lchownat(2) system call.
uid	The original uid, exactly as passed to the lchownat(2) system call.
gid	The original gid, exactly as passed to the lchownat(2) system call.

Definition at line 63 of file lchownat.c.