explain_tcflow_or_die(3) [debian man page]
explain_tcflow_or_die(3) Library Functions Manual explain_tcflow_or_die(3) NAME
explain_tcflow_or_die - terminal flow control and report errors SYNOPSIS
#include <libexplain/tcflow.h> void explain_tcflow_or_die(int fildes, int action); int explain_tcflow_on_error(int fildes, int action); DESCRIPTION
The explain_tcflow_or_die function is used to call the tcflow(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcflow(3) function, and then the process terminates by calling exit(EXIT_FAILURE). The explain_tcflow_on_error function is used to call the tcflow(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_tcflow(3) function, but still returns to the caller. fildes The fildes, exactly as to be passed to the tcflow(3) system call. action The action, exactly as to be passed to the tcflow(3) system call. RETURN VALUE
The explain_tcflow_or_die function only returns on success, see tcflow(3) for more information. On failure, prints an explanation and exits, it does not return. The explain_tcflow_on_error function always returns the value return by the wrapped tcflow(3) system call. EXAMPLE
The explain_tcflow_or_die function is intended to be used in a fashion similar to the following example: explain_tcflow_or_die(fildes, action); SEE ALSO
tcflow(3) terminal flow control explain_tcflow(3) explain tcflow(3) errors exit(2) terminate the calling process COPYRIGHT
libexplain version 0.52 Copyright (C) 2009 Peter Miller explain_tcflow_or_die(3)
Check Out this Related Man Page
tcflow(3C) Standard C Library Functions tcflow(3C) NAME
tcflow - suspend or restart the transmission or reception of data SYNOPSIS
#include <termios.h> int tcflow(int fildes, int action); DESCRIPTION
The tcflow() function suspends transmission or reception of data on the object referred to by fildes, depending on the value of action. The fildes argument is an open file descriptor associated with a terminal. o If action is TCOOFF, output is suspended. o If action is TCOON, suspended output is restarted. o If action is TCIOFF, the system transmits a STOP character, which is intended to cause the terminal device to stop transmitting data to the system. o If action is TCION, the system transmits a START character, which is intended to cause the terminal device to start transmitting data to the system. The default on the opening of a terminal file is that neither its input nor its output are suspended. Attempts to use tcflow() from a process which is a member of a background process group on a fildes associated with its controlling termi- nal, will cause the process group to be sent a SIGTTOU signal. If the calling process is blocking or ignoring SIGTTOU signals, the process is allowed to perform the operation, and no signal is sent. RETURN VALUES
Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error. ERRORS
The tcflow() function will fail if: EBADF The fildes argument is not a valid file descriptor. EINVAL The action argument is not a supported value. ENOTTY The file associated with fildes is not a terminal. The tcflow() function may fail if: EIO The process group of the writing process is orphaned, and the writing process is not ignoring or blocking SIGTTOU. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-------------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-------------------------------+ |Interface Stability |Standard | +-----------------------------+-------------------------------+ |MT-Level |MT-Safe, and Async-Signal-Safe | +-----------------------------+-------------------------------+ SEE ALSO
tcsendbreak(3C), attributes(5), standards(5), termio(7I) SunOS 5.11 14 Aug 2002 tcflow(3C)