libexplain/wait3_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/wait.h>
#include <libexplain/wait3.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_wait3_on_error (int *status, int options, struct rusage *rusage)

---

Function Documentation

int explain_wait3_on_error	(	int *	status,
		int	options,
		struct rusage *	rusage
	)

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

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

 pid_t pid = explain_wait3_on_error(status, options, rusage);
 if (pid < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

status	The status, exactly as to be passed to the wait3(2) system call.
options	The options, exactly as to be passed to the wait3(2) system call.
rusage	The rusage, exactly as to be passed to the wait3(2) system call.

Returns:

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

Definition at line 27 of file wait3_on_error.c.