libexplain/buffer/errno/execve.h File Reference

#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_execve (explain_string_buffer_t *sb, int errnum, const char *pathname, char *const *argv, char *const *envp)
void	explain_buffer_errno_execve_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *pathname, char *const *argv, char *const *envp)

---

Function Documentation

void explain_buffer_errno_execve	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	pathname,
		char *const *	argv,
		char *const *	envp
	)

The explain_buffer_errno_execve function is used to obtain an explanation of an error returned by the execve(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 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 execve(2) system call.
argv	The original argv, exactly as passed to the execve(2) system call.
envp	The original envp, exactly as passed to the execve(2) system call.

Definition at line 491 of file execve.c.

void explain_buffer_errno_execve_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	pathname,
		char *const *	argv,
		char *const *	envp
	)

The explain_buffer_errno_execve_explanation function is used by the explain_buffer_errno_execve function (and others) to print the cause of the error, i.e. "because" and everything after it.

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 execve(2) system call.
argv	The original argv, exactly as passed to the execve(2) system call.
envp	The original envp, exactly as passed to the execve(2) system call.

Definition at line 199 of file execve.c.