usr/src/man/man3xcurses/intrflush.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH INTRFLUSH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 intrflush \-  enable or disable flush on interrupt
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBintrflush\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIwin\fR\fR
  27 .ad
  28 .RS 7n
  29 Is ignored.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIbf\fR\fR
  36 .ad
  37 .RS 7n
  38 Is a Boolean expression.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBintrflush()\fR function specifies whether pressing an interrupt key
  45 (interrupt, suspend, or quit) will flush the input buffer associated with the
  46 current screen. If the value of \fIbf\fR is \fBTRUE\fR, then flushing of the
  47 output buffer associated with the current screen will occur when an interrupt
  48 key (interrupt, suspend, or quit) is pressed.If the value of \fIbf\fR is
  49 \fBFALSE\fR, then no flushing of the buffer will occur when an interrupt key is
  50 pressed. The default for the option is inherited from the display driver
  51 settings. The \fIwin\fR argument is ignored.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 Upon successful completion, \fBintrflush()\fR returns \fBOK\fR. Otherwise, it
  56 returns \fBERR\fR.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 No errors are defined.
  61 .SH ATTRIBUTES
  62 .sp
  63 .LP
  64 See \fBattributes\fR(5) for descriptions of the following attributes:
  65 .sp
  66
  67 .sp
  68 .TS
  69 box;
  70 c | c
  71 l | l .
  72 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  73 _
  74 Interface Stability     Standard
  75 _
  76 MT-Level        Unsafe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBflushinp\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBqiflush\fR(3XCURSES),
  83 \fBattributes\fR(5), \fBstandards\fR(5)