explain_tcflush_or_die(3)

explain_tcflush_or_die3

Discard terminal data and report errors

Usage

#include <libexplain/tcflush.h>

void explain_tcflush_or_die(int fildes, int selector);
int explain_tcflush_on_error(int fildes, int selector);

Overview

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

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

fildes

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

selector

The selector, exactly as to be passed to the tcflush(3) system call.

Return value

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

The explain_tcflush_on_error function always returns the value return by the wrapped tcflush(3) system call.

Examples

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

explain_tcflush_or_die(fildes, selector);

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.