1explain_tcsendbreak_or_die(3L)ibrary Functions Manuaelxplain_tcsendbreak_or_die(3)
2
3
4

NAME

6       explain_tcsendbreak_or_die - send terminal line break and report errors
7

SYNOPSIS

9       #include <libexplain/tcsendbreak.h>
10       void explain_tcsendbreak_or_die(int fildes, int duration);
11       int explain_tcsendbreak_on_error(int fildes, int duration);
12

DESCRIPTION

14       The  explain_tcsendbreak_or_die  function  is  used to call the tcsend‐
15       break(3) system call. On failure an  explanation  will  be  printed  to
16       stderr, obtained from the explain_tcsendbreak(3) function, and then the
17       process terminates by calling exit(EXIT_FAILURE).
18
19       The explain_tcsendbreak_on_error function is used to call  the  tcsend‐
20       break(3)  system  call.  On  failure  an explanation will be printed to
21       stderr, obtained from the explain_tcsendbreak(3)  function,  but  still
22       returns to the caller.
23
24       fildes  The  fildes, exactly as to be passed to the tcsendbreak(3) sys‐
25               tem call.
26
27       duration
28               The duration, exactly as to be  passed  to  the  tcsendbreak(3)
29               system call.
30

RETURN VALUE

32       The  explain_tcsendbreak_or_die  function  only returns on success, see
33       tcsendbreak(3) for more information. On failure, prints an  explanation
34       and exits, it does not return.
35
36       The  explain_tcsendbreak_on_error  function  always  returns  the value
37       return by the wrapped tcsendbreak(3) system call.
38

EXAMPLE

40       The explain_tcsendbreak_or_die function is intended to  be  used  in  a
41       fashion similar to the following example:
42              explain_tcsendbreak_or_die(fildes, duration);
43

SEE ALSO

45       tcsendbreak(3)
46               send terminal line break
47
48       explain_tcsendbreak(3)
49               explain tcsendbreak(3) errors
50
51       exit(2) terminate the calling process
52

54       libexplain version 1.4
55       Copyright (C) 2009 Peter Miller
56
57
58
59                                                 explain_tcsendbreak_or_die(3)
Impressum