libexplain/tcflow_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/termios.h>
#include <libexplain/tcflow.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_tcflow_on_error (int fildes, int action)

---

Function Documentation

int explain_tcflow_on_error	(	int	fildes,
		int	action
	)

The explain_tcflow_on_error function is used to call the tcflow(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcflow(3) function.

Parameters:

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

Returns:

The value returned by the wrapped tcflow(3) system call.

Example:

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

 if (explain_tcflow_on_error(fildes, action) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file tcflow_on_error.c.