libexplain  1.4.D001
Functions
libexplain/tcsendbreak_on_error.c File Reference
#include <libexplain/ac/errno.h>
#include <libexplain/ac/termios.h>
#include <libexplain/tcsendbreak.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions

int explain_tcsendbreak_on_error (int fildes, int duration)

Function Documentation

int explain_tcsendbreak_on_error ( int  fildes,
int  duration 
)

The explain_tcsendbreak_on_error function is used to call the tcsendbreak(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcsendbreak(3) function.

Parameters:
fildesThe fildes, exactly as to be passed to the tcsendbreak(3) system call.
durationThe duration, exactly as to be passed to the tcsendbreak(3) system call.
Returns:
The value returned by the wrapped tcsendbreak(3) system call.
Example:
This function is intended to be used in a fashion similar to the following example:
 if (explain_tcsendbreak_on_error(fildes, duration) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file tcsendbreak_on_error.c.