usr/src/man/man3c/tcflush.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH TCFLUSH 3C "Aug 14, 2002"
  47 .SH NAME
  48 tcflush \- flush non-transmitted output data, non-read input data or both
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <termios.h>
  53
  54 \fBint\fR \fBtcflush\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIqueue_selector\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 Upon successful completion, \fBtcflush()\fR discards data written to the object
  61 referred to by \fIfildes\fR (an open file descriptor associated with a
  62 terminal) but not transmitted, or data received but not read, depending on the
  63 value of \fIqueue_selector\fR:
  64 .RS +4
  65 .TP
  66 .ie t \(bu
  67 .el o
  68 If \fIqueue_selector\fR is \fBTCIFLUSH\fR it flushes data received but not
  69 read.
  70 .RE
  71 .RS +4
  72 .TP
  73 .ie t \(bu
  74 .el o
  75 If \fIqueue_selector\fR is \fBTCOFLUSH\fR it flushes data written but not
  76 transmitted.
  77 .RE
  78 .RS +4
  79 .TP
  80 .ie t \(bu
  81 .el o
  82 If \fIqueue_selector\fR is \fBTCIOFLUSH\fR it flushes both data received but
  83 not read and data written but not transmitted.
  84 .RE
  85 .sp
  86 .LP
  87 Attempts to use \fBtcflush()\fR from a process which is a member of a
  88 background process group on a \fIfildes\fR associated with its controlling
  89 terminal, will cause the process group to be sent a \fBSIGTTOU\fR signal. If
  90 the calling process is blocking or ignoring \fBSIGTTOU\fR signals, the process
  91 is allowed to perform the operation, and no signal is sent.
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  96 returned and \fBerrno\fR is set to indicate the error.
  97 .SH ERRORS
  98 .sp
  99 .LP
 100 The \fBtcflush()\fR function will fail if:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBEBADF\fR\fR
 105 .ad
 106 .RS 10n
 107 The \fIfildes\fR argument is not a valid file descriptor.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEINVAL\fR\fR
 114 .ad
 115 .RS 10n
 116 The \fIqueue_selector\fR argument is not a supported value.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBENOTTY\fR\fR
 123 .ad
 124 .RS 10n
 125 The file associated with \fIfildes\fR is not a terminal.
 126 .RE
 127
 128 .sp
 129 .LP
 130 The \fBtcflush()\fR function may fail if:
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBEIO\fR\fR
 135 .ad
 136 .RS 7n
 137 The process group of the writing process is orphaned, and the writing process
 138 is not ignoring or blocking \fBSIGTTOU\fR.
 139 .RE
 140
 141 .SH ATTRIBUTES
 142 .sp
 143 .LP
 144 See \fBattributes\fR(5) for descriptions of the following attributes:
 145 .sp
 146
 147 .sp
 148 .TS
 149 box;
 150 c | c
 151 l | l .
 152 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 153 _
 154 Interface Stability     Standard
 155 _
 156 MT-Level        MT-Safe, and Async-Signal-Safe
 157 .TE
 158
 159 .SH SEE ALSO
 160 .sp
 161 .LP
 162 \fBtcdrain\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I)