explain_tcsendbreak_or_die(3) [debian man page]
explain_tcsendbreak_or_die(3) Library Functions Manual explain_tcsendbreak_or_die(3) NAME
explain_tcsendbreak_or_die - send terminal line break and report errors SYNOPSIS
#include <libexplain/tcsendbreak.h> void explain_tcsendbreak_or_die(int fildes, int duration); int explain_tcsendbreak_on_error(int fildes, int duration); DESCRIPTION
The explain_tcsendbreak_or_die 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, and then the process terminates by calling exit(EXIT_FAILURE). 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, but still returns to the caller. fildes The fildes, exactly as to be passed to the tcsendbreak(3) system call. duration The duration, exactly as to be passed to the tcsendbreak(3) system call. RETURN VALUE
The explain_tcsendbreak_or_die function only returns on success, see tcsendbreak(3) for more information. On failure, prints an explanation and exits, it does not return. The explain_tcsendbreak_on_error function always returns the value return by the wrapped tcsendbreak(3) system call. EXAMPLE
The explain_tcsendbreak_or_die function is intended to be used in a fashion similar to the following example: explain_tcsendbreak_or_die(fildes, duration); SEE ALSO
tcsendbreak(3) send terminal line break explain_tcsendbreak(3) explain tcsendbreak(3) errors exit(2) terminate the calling process COPYRIGHT
libexplain version 0.52 Copyright (C) 2009 Peter Miller explain_tcsendbreak_or_die(3)
Check Out this Related Man Page
tcsendbreak(3C) Standard C Library Functions tcsendbreak(3C) NAME
tcsendbreak - send a ``break'' for a specific duration SYNOPSIS
#include <termios.h> int tcsendbreak(int fildes, int duration); DESCRIPTION
The fildes argument is an open file descriptor associated with a terminal. If the terminal is using asynchronous serial data transmission, tcsendbreak() will cause transmission of a continuous stream of zero-valued bits for a specific duration. If duration is 0, it will cause transmission of zero-valued bits for at least 0.25 seconds, and not more than 0.5 seconds. If duration is not 0, it behaves in a way similar to tcdrain(3C). If the terminal is not using asynchronous serial data transmission, it sends data to generate a break condition or returns without taking any action. Attempts to use tcsendbreak() from a process which is a member of a background process group on a fildes associated with its controlling terminal 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 tcsendbreak() function will fail if: EBADF The fildes argument is not a valid file descriptor. ENOTTY The file associated with fildes is not a terminal. The tcsendbreak() 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
tcdrain(3C), attributes(5), standards(5), termio(7I) SunOS 5.10 14 Aug 2002 tcsendbreak(3C)