libexplain/kill_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/signal.h>
#include <libexplain/ac/sys/types.h>
#include <libexplain/kill.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_kill_on_error (pid_t pid, int sig)

---

Function Documentation

int explain_kill_on_error	(	pid_t	pid,
		int	sig
	)

The explain_kill_on_error function is used to call the kill(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_kill(3) function.

Parameters:

pid	The pid, exactly as to be passed to the kill(2) system call.
sig	The sig, exactly as to be passed to the kill(2) system call.

Returns:

The value returned by the wrapped kill(2) system call.

Example:

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

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

Definition at line 28 of file kill_on_error.c.