libexplain/tcsetattr_on_error.c File Reference

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

Go to the source code of this file.

Functions
int	explain_tcsetattr_on_error (int fildes, int options, const struct termios *data)

---

Function Documentation

int explain_tcsetattr_on_error	(	int	fildes,
		int	options,
		const struct termios *	data
	)

The explain_tcsetattr_on_error function is used to call the tcsetattr(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcsetattr(3) function.

Parameters:

fildes	The fildes, exactly as to be passed to the tcsetattr(3) system call.
options	The options, exactly as to be passed to the tcsetattr(3) system call.
data	The data, exactly as to be passed to the tcsetattr(3) system call.

Returns:

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

Example:

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

 if (explain_tcsetattr_on_error(fildes, options, data) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file tcsetattr_on_error.c.