libexplain/tcflush_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_tcflush_on_error (int fildes, int selector)

---

Function Documentation

int explain_tcflush_on_error	(	int	fildes,
		int	selector
	)

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.

Parameters:

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.

Returns:

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

Example:

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

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

Definition at line 27 of file tcflush_on_error.c.