libexplain/buffer/errno/open.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_open (explain_string_buffer_t *sb, int errnum, const char *pathname, int flags, int mode)
void	explain_buffer_errno_open_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *pathname, int flags, int mode)

---

Function Documentation

void explain_buffer_errno_open	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	pathname,
		int	flags,
		int	mode
	)

The explain_buffer_errno_open function is used to obtain an explanation of an error returned by the open(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.
pathname	The original pathname, exactly has passed to the open(2) system call.
flags	The original flags, exactly has passed to the open(2) system call.
mode	The original mode, exactly has passed to the open(2) system call (or zero if the original call didn't need a mode argument).

Definition at line 732 of file open.c.

void explain_buffer_errno_open_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	pathname,
		int	flags,
		int	mode
	)

The explain_buffer_errno_open_because function is used to obtain an explanation of an error returned by the open(2) system call. It does not include the initial text of the function call, only the "because..." part.

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.
syscall_name	The name of the offending system call.
pathname	The original pathname, exactly has passed to the open(2) system call.
flags	The original flags, exactly has passed to the open(2) system call.
mode	The original mode, exactly has passed to the open(2) system call (or zero if the original call didn't need a mode argument).

Definition at line 163 of file open.c.