libexplain/buffer/errno/rmdir.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_rmdir (explain_string_buffer_t *sb, int errnum, const char *pathname)
void	explain_buffer_errno_rmdir_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *pathname)

---

Function Documentation

void explain_buffer_errno_rmdir	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	pathname
	)

The explain_buffer_errno_rmdir function may be used to describe errors returned by the rmdir() 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 safe 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.
pathname	The original pathname, exactly as passed to the rmdir(2) system call.

Definition at line 274 of file rmdir.c.

void explain_buffer_errno_rmdir_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	pathname
	)

The explain_buffer_errno_rmdir_explanation function is used by the explain_buffer_errno_rmdir function (and others) to print the explanation "because..." part.

Parameters:

sb	The string buffer to print the message into.
errnum	The error value to be decoded.
syscall_name	The name of the offending system call.
pathname	The original pathname, exactly as passed to the rmdir(2) system call.

Definition at line 110 of file rmdir.c.