explain_tcdrain_or_die(3)

explain_tcdrain_or_die3

Execute tcdrain(3) and report errors

Usage

#include <libexplain/tcdrain.h>

void explain_tcdrain_or_die(int fildes);
int explain_tcdrain_on_error(int fildes);

Overview

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

The explain_tcdrain_on_error function is used to call the tcdrain(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcdrain(3) function, but still returns to the caller.

fildes

The fildes, exactly as to be passed to the tcdrain(3) system call.

Return value

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

The explain_tcdrain_on_error function always returns the value return by the wrapped tcdrain(3) system call.

Examples

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

explain_tcdrain_or_die(fildes);

Releases

6 releases since Debian 7 (Wheezy); the text changed 1 time.

  1. 7
  2. 9–13

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