libexplain/raise_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/signal.h>
#include <libexplain/raise.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_raise_on_error (int sig)

---

Function Documentation

int explain_raise_on_error

(

int

sig

)

The explain_raise_on_error function is used to call the raise(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_raise(3) function.

Parameters:

sig	The sig, exactly as to be passed to the raise(3) system call.

Returns:

The value returned by the wrapped raise(3) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (explain_raise_on_error(sig) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file raise_on_error.c.