Content-type: text/html Man page of tcflush

tcflush

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

tcflush - Flushes nontransmitted output data or nonread input data  

LIBRARY

Standard C Library (libc.so, libc.a)  

SYNOPSIS

#include <termios.h>

int tcflush(
        int filedes,
        int queue_selector);  

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

tcflush():  XPG4, XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.  

PARAMETERS

Specifies an open file descriptor associated with a terminal. Specifies one of the following: Flush data received but not read. Flush data written but not transmitted. Flush both data received but not read and data written but not transmitted.  

DESCRIPTION

The tcflush() function discards any data written to the object referred to by the filedes parameter, or data received but not read by the object referred to by filedes, depending on the value of the queue_selector parameter.

A process group is sent a SIGTTOU signal if the tcflush() function is called from one of its member processes. 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, a value of 0 (zero) is returned. Otherwise, a value of -1 is returned and errno is set to indicate the error.  

ERRORS

The tcflush() function sets errno to the specified values for the following conditions:

The filedes parameter does not specify a valid file descriptor. The queue_selector parameter does not specify a proper value. The file associated with the filedes parameter is not a terminal.  

RELATED INFORMATION

Functions: tcdrain(3), tcflow(3), tcsendbreak(3)

Files: termios (4)

Standards: standards(5) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:01 GMT, October 02, 2010