libexplain/waitpid_or_die.c File Reference

#include <libexplain/output.h>
#include <libexplain/waitpid.h>

Go to the source code of this file.

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

---

Function Documentation

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

The explain_waitpid_or_die 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, and then the process terminates by calling exit(EXIT_FAILURE).

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

 pid_t result = explain_waitpid_or_die(pid, status, options);

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:

This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 24 of file waitpid_or_die.c.