libexplain/buffer/errno/realpath.h File Reference

#include <libexplain/ac/stdlib.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_realpath (explain_string_buffer_t *sb, int errnum, const char *pathname, char *resolved_pathname)
void	explain_buffer_errno_realpath_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *pathname, char *resolved_pathname)

---

Function Documentation

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

The explain_buffer_errno_realpath function is used to obtain an explanation of an error returned by the realpath(3) 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.
pathname	The original pathname, exactly as passed to the realpath(3) system call.
resolved_pathname	The original resolved_pathname, exactly as passed to the realpath(3) system call.

Definition at line 119 of file realpath.c.

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

The explain_buffer_errno_realpath_explanation function is used to obtain the explanation (the part after "because") of an error returned by the realpath(3) 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.
pathname	The original pathname, exactly as passed to the realpath(3) system call.
resolved_pathname	The original resolved_pathname, exactly as passed to the realpath(3) system call.

Definition at line 51 of file realpath.c.