libexplain/message/kill.c File Reference

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

Go to the source code of this file.

Functions
void	explain_message_kill (char *message, int message_size, pid_t pid, int sig)

---

Function Documentation

void explain_message_kill	(	char *	message,
		int	message_size,
		pid_t	pid,
		int	sig
	)

The explain_message_kill function is used to obtain an explanation of an error returned by the kill(2) 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.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
pid	The original pid, exactly as passed to the kill(2) system call.
sig	The original sig, exactly as passed to the kill(2) system call.

Example:

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

 if (kill(pid, sig) < 0)
 {
     char message[3000];
     explain_message_kill(message, sizeof(message), pid, sig);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_kill_or_die function.

Definition at line 26 of file kill.c.