libexplain  1.4.D001
Functions
libexplain/buffer/errno/raise.c File Reference
#include <libexplain/ac/unistd.h>
#include <libexplain/buffer/errno/kill.h>
#include <libexplain/buffer/errno/raise.h>
#include <libexplain/buffer/signal.h>
#include <libexplain/explanation.h>

Go to the source code of this file.

Functions

static void explain_buffer_errno_raise_system_call (explain_string_buffer_t *sb, int errnum, int sig)
void explain_buffer_errno_raise_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int sig)
void explain_buffer_errno_raise (explain_string_buffer_t *sb, int errnum, int sig)

Function Documentation

void explain_buffer_errno_raise ( explain_string_buffer_t sb,
int  errnum,
int  sig 
)

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

Definition at line 59 of file raise.c.

void explain_buffer_errno_raise_explanation ( explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
int  sig 
)

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

Definition at line 39 of file raise.c.

static void explain_buffer_errno_raise_system_call ( explain_string_buffer_t sb,
int  errnum,
int  sig 
) [static]

Definition at line 28 of file raise.c.