libexplain/message/wait3.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/wait3.h>

Go to the source code of this file.

Functions
void	explain_message_wait3 (char *message, int message_size, int *status, int options, struct rusage *rusage)

---

Function Documentation

void explain_message_wait3	(	char *	message,
		int	message_size,
		int *	status,
		int	options,
		struct rusage *	rusage
	)

The explain_message_wait3 function is used to obtain an explanation of an error returned by the wait3(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.

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

 pid_t pid = wait3(status, options, rusage);
 if (pid < 0)
 {
     char message[3000];
     explain_message_wait3(message, sizeof(message), status, options,
         rusage);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

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

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.
status	The original status, exactly as passed to the wait3(2) system call.
options	The original options, exactly as passed to the wait3(2) system call.
rusage	The original rusage, exactly as passed to the wait3(2) system call.

Definition at line 25 of file wait3.c.