explain_pipe2_or_die(3)

explain_pipe2_or_die3

Create pipe and report errors

Usage

#include <libexplain/pipe2.h>

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

Overview

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).

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, but still returns to the caller.

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.

Return value

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

The explain_pipe2_on_error function always returns the value return by the wrapped pipe2(2) system call.

Examples

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

explain_pipe2_or_die(fildes, flags);

Releases

Unchanged in 5 releases since Debian 9 (Stretch).

  1. 9–13

From libexplain-dev 1.4.D001-16 in Debian 13 (Trixie). Parsed by carta from the page's man source.