libexplain/waitpid_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_waitpid_on_error (int pid, int *status, int options)

---

Function Documentation

int explain_waitpid_on_error	(	int	pid,
		int *	status,
		int	options
	)

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

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

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

Parameters:

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

Returns:

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

Definition at line 27 of file waitpid_on_error.c.