---
name: "explain_tcflow_or_die"
section: "3"
platform: "linux"
package: "libexplain-dev"
version: "1.4.D001-16"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/explain_tcflow_or_die"
---

# explain\_tcflow\_or\_die(3)

terminal flow control and report errors

## NAME

explain\_tcflow\_or\_die - terminal flow control and report errors

## SYNOPSIS

\#include \<libexplain/tcflow.h\>

void explain\_tcflow\_or\_die(int fildes, int action);\
 int explain\_tcflow\_on\_error(int fildes, int action);

## DESCRIPTION

The **explain\_tcflow\_or\_die** function is used to call the [*tcflow*(3)](/tcflow/3.md) system call. On failure an explanation will be printed to *stderr*, obtained from the [*explain\_tcflow*(3)](/explain_tcflow/3.md) function, and then the process terminates by calling `exit(EXIT_FAILURE)`.

The **explain\_tcflow\_on\_error** function is used to call the [*tcflow*(3)](/tcflow/3.md) system call. On failure an explanation will be printed to *stderr*, obtained from the [*explain\_tcflow*(3)](/explain_tcflow/3.md) function, but still returns to the caller.

- *fildes*

  The fildes, exactly as to be passed to the [*tcflow*(3)](/tcflow/3.md) system call.

- *action*

  The action, exactly as to be passed to the [*tcflow*(3)](/tcflow/3.md) system call.

## RETURN VALUE

The **explain\_tcflow\_or\_die** function only returns on success, see [*tcflow*(3)](/tcflow/3.md) for more information. On failure, prints an explanation and exits, it does not return.

The **explain\_tcflow\_on\_error** function always returns the value return by the wrapped [*tcflow*(3)](/tcflow/3.md) system call.

## EXAMPLE

The **explain\_tcflow\_or\_die** function is intended to be used in a fashion similar to the following example:

```
explain_tcflow_or_die(fildes, action);
```

## SEE ALSO

- [*tcflow*(3)](/tcflow/3.md)

  terminal flow control

- [*explain\_tcflow*(3)](/explain_tcflow/3.md)

  explain [*tcflow*(3)](/tcflow/3.md) errors

- [*exit*(2)](/exit/2.md)

  terminate the calling process

## COPYRIGHT

libexplain version 1.4\
 Copyright (C) 2009 Peter Miller