libexplain  1.4.D001
Functions
libexplain/buffer/errno/setenv.h File Reference
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions

void explain_buffer_errno_setenv (explain_string_buffer_t *sb, int errnum, const char *name, const char *value, int overwrite)
void explain_buffer_errno_setenv_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *name, const char *value, int overwrite)

Function Documentation

void explain_buffer_errno_setenv ( explain_string_buffer_t sb,
int  errnum,
const char *  name,
const char *  value,
int  overwrite 
)

The explain_buffer_errno_setenv function is used to obtain an explanation of an error returned by the setenv(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:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe 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.
nameThe original name, exactly as passed to the setenv(3) system call.
valueThe original value, exactly as passed to the setenv(3) system call.
overwriteThe original overwrite, exactly as passed to the setenv(3) system call.

Definition at line 103 of file setenv.c.

void explain_buffer_errno_setenv_explanation ( explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
const char *  name,
const char *  value,
int  overwrite 
)

The explain_buffer_errno_setenv_explanation function is used to obtain the explanation (the part after "because") of an error returned by the setenv(3) system call (and similar).

Parameters:
sbThe string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnumThe 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_nameThe name of the offending system call.
nameThe original name, exactly as passed to the setenv(3) system call.
valueThe original value, exactly as passed to the setenv(3) system call.
overwriteThe original overwrite, exactly as passed to the setenv(3) system call.

Definition at line 49 of file setenv.c.