libexplain/tcdrain_or_die.c File Reference

#include <libexplain/output.h>
#include <libexplain/tcdrain.h>

Go to the source code of this file.

Functions
void	explain_tcdrain_or_die (int fildes)

---

Function Documentation

void explain_tcdrain_or_die

(

int

fildes

)

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

Parameters:

fildes

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

Returns:

This function only returns on success, see tcdrain(3) 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_tcdrain_or_die(fildes);

Definition at line 24 of file tcdrain_or_die.c.