libexplain/buffer/errno/linkat.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_linkat (explain_string_buffer_t *sb, int errnum, int old_fildes, const char *old_path, int new_fildes, const char *new_path, int flags)
void	explain_buffer_errno_linkat_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int old_fildes, const char *old_path, int new_fildes, const char *new_path, int flags)

---

Function Documentation

void explain_buffer_errno_linkat	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	old_fildes,
		const char *	old_path,
		int	new_fildes,
		const char *	new_path,
		int	flags
	)

The explain_buffer_errno_linkat function is used to obtain an explanation of an error returned by the linkat(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.
old_fildes	The original old_fildes, exactly as passed to the linkat(2) system call.
old_path	The original old_path, exactly as passed to the linkat(2) system call.
new_fildes	The original new_fildes, exactly as passed to the linkat(2) system call.
new_path	The original new_path, exactly as passed to the linkat(2) system call.
flags	The original flags, exactly as passed to the linkat(2) system call.

Definition at line 347 of file linkat.c.

void explain_buffer_errno_linkat_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	old_fildes,
		const char *	old_path,
		int	new_fildes,
		const char *	new_path,
		int	flags
	)

The explain_buffer_errno_linkat_explanation function is used to obtain the explanation (the part after "because") of an error returned by the linkat(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.
old_fildes	The original old_fildes, exactly as passed to the linkat(2) system call.
old_path	The original old_path, exactly as passed to the linkat(2) system call.
new_fildes	The original new_fildes, exactly as passed to the linkat(2) system call.
new_path	The original new_path, exactly as passed to the linkat(2) system call.
flags	The original flags, exactly as passed to the linkat(2) system call.

Definition at line 113 of file linkat.c.