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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, 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 FLUSHINP 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 flushinp \- discard type-ahead characters
   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 \fBflushinp\fR(\fBvoid\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBflushinp()\fR function discards (flushes) any characters in the input
  26 buffer associated with the current screen.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 The \fBflushinp()\fR function always returns \fBOK\fR.
  31 .SH ERRORS
  32 .sp
  33 .LP
  34 No errors are defined.
  35 .SH ATTRIBUTES
  36 .sp
  37 .LP
  38 See \fBattributes\fR(5) for descriptions of the following attributes:
  39 .sp
  40
  41 .sp
  42 .TS
  43 box;
  44 c | c
  45 l | l .
  46 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  47 _
  48 Interface Stability     Standard
  49 _
  50 MT-Level        Unsafe
  51 .TE
  52
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)