1explain_tcflow_or_die(3)   Library Functions Manual   explain_tcflow_or_die(3)
2
3
4

NAME

6       explain_tcflow_or_die - terminal flow control and report errors
7

SYNOPSIS

9       #include <libexplain/tcflow.h>
10       void explain_tcflow_or_die(int fildes, int action);
11       int explain_tcflow_on_error(int fildes, int action);
12

DESCRIPTION

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

RETURN VALUE

30       The  explain_tcflow_or_die  function  only  returns  on  success,   see
31       tcflow(3)  for  more information. On failure, prints an explanation and
32       exits, it does not return.
33
34       The explain_tcflow_on_error function always returns the value return by
35       the wrapped tcflow(3) system call.
36

EXAMPLE

38       The  explain_tcflow_or_die function is intended to be used in a fashion
39       similar to the following example:
40              explain_tcflow_or_die(fildes, action);
41

SEE ALSO

43       tcflow(3)
44               terminal flow control
45
46       explain_tcflow(3)
47               explain tcflow(3) errors
48
49       exit(2) terminate the calling process
50

52       libexplain version 1.4
53       Copyright (C) 2009 Peter Miller
54
55
56
57                                                      explain_tcflow_or_die(3)
Impressum