libexplain/buffer/errno/putenv.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/buffer/enomem.h>
#include <libexplain/buffer/errno/generic.h>
#include <libexplain/buffer/errno/putenv.h>
#include <libexplain/buffer/pathname.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions
static void	explain_buffer_errno_putenv_system_call (explain_string_buffer_t *sb, int errnum, const char *string)
void	explain_buffer_errno_putenv_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *string)
void	explain_buffer_errno_putenv (explain_string_buffer_t *sb, int errnum, const char *string)

---

Function Documentation

void explain_buffer_errno_putenv	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	string
	)

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

Definition at line 61 of file putenv.c.

void explain_buffer_errno_putenv_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		const char *	string
	)

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

Definition at line 40 of file putenv.c.

static void explain_buffer_errno_putenv_system_call	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	string
	)		[static]

Definition at line 29 of file putenv.c.