libexplain/buffer/errno/unlink.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_unlink (explain_string_buffer_t *sb, int errnum, const char *path)
void	explain_buffer_errno_unlink_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *path)

---

Function Documentation

void explain_buffer_errno_unlink	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	path
	)

The explain_buffer_errno_unlink function is used to obtain an explanation of an error returned by the unlink(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 in which the message is being constructed. If a safe buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtain 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.
path	The original path, exactly has passed to the unlink(2) system call.

Definition at line 198 of file unlink.c.

void explain_buffer_errno_unlink_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	path
	)

The explain_buffer_errno_unlink_explanation function is used by the explain_buffer_errno_unlink function (and others) to print the extended "because..." part of the explanation.

Parameters:

sb	The string buffer in which the message is being constructed.
errnum	The error value to be decoded.
syscall_name	The name of the offending system call.
path	The original path, exactly has passed to the unlink(2) system call.

Definition at line 61 of file unlink.c.