libexplain/getpgid_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/getpgid.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
pid_t	explain_getpgid_or_die (pid_t pid)
pid_t	explain_getpgid_on_error (pid_t pid)

---

Function Documentation

pid_t explain_getpgid_on_error

(

pid_t

pid

)

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

Parameters:

pid	The pid, exactly as to be passed to the getpgid(2) system call.

Returns:

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

Example:

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

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

Definition at line 41 of file getpgid_or_die.c.

pid_t explain_getpgid_or_die

(

pid_t

pid

)

The explain_getpgid_or_die function is used to call the getpgid(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_getpgid(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

pid	The pid, exactly as to be passed to the getpgid(2) system call.

Returns:

This function only returns on success, see getpgid(2) for more information. On failure, prints an explanation and exits, it does not return.

Example:

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

 pid_t result = explain_getpgid_or_die(pid);

Definition at line 27 of file getpgid_or_die.c.