libexplain/pipe2_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_pipe2_or_die (int *fildes, int flags)
int	explain_pipe2_on_error (int *fildes, int flags)

---

Function Documentation

int explain_pipe2_on_error	(	int *	fildes,
		int	flags
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the pipe2(2) system call.
flags	The flags, exactly as to be passed to the pipe2(2) system call.

Returns:

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

Example:

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

 if (explain_pipe2_on_error(fildes, flags) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 37 of file pipe2_or_die.c.

void explain_pipe2_or_die	(	int *	fildes,
		int	flags
	)

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

Parameters:

fildes	The fildes, exactly as to be passed to the pipe2(2) system call.
flags	The flags, exactly as to be passed to the pipe2(2) system call.

Returns:

This function only returns on success, see pipe2(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_pipe2_or_die(fildes, flags);

Definition at line 27 of file pipe2_or_die.c.