libexplain/setpgid_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_setpgid_or_die (pid_t pid, pid_t pgid)
int	explain_setpgid_on_error (pid_t pid, pid_t pgid)

---

Function Documentation

int explain_setpgid_on_error	(	pid_t	pid,
		pid_t	pgid
	)

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

Parameters:

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

Returns:

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

Example:

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

 if (explain_setpgid_on_error(pid, pgid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file setpgid_or_die.c.

void explain_setpgid_or_die	(	pid_t	pid,
		pid_t	pgid
	)

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

Parameters:

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

Returns:

This function only returns on success, see setpgid(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:

 explain_setpgid_or_die(pid, pgid);

Definition at line 27 of file setpgid_or_die.c.