usr/src/man/man3xcurses/ungetch.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 UNGETCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 ungetch, unget_wch \- push character back onto the input queue
   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 \fBungetch\fR(\fBint\fR \fIch\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBunget_wch\fR(\fBconst wchar_t\fR \fIwch\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIch\fR\fR
  32 .ad
  33 .RS 7n
  34 Is the single byte character to be put back in the input queue for the  next
  35 call to \fBgetch\fR(3XCURSES).
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIwch\fR\fR
  42 .ad
  43 .RS 7n
  44 Is the wide character to be put back in the input queue for the next call  to
  45 \fBget_wch\fR(3XCURSES).
  46 .RE
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 The \fBungetch()\fR function pushes \fIch\fR back onto the input queue until
  52 the next  call to \fBgetch()\fR.
  53 .sp
  54 .LP
  55 The \fBunget_wch()\fR function is similar to \fBungetch()\fR except that
  56 \fIch\fR can be of type \fBwchar_t\fR.
  57 .SH RETURN VALUES
  58 .sp
  59 .LP
  60 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  61 .SH ERRORS
  62 .sp
  63 .LP
  64 None.
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Standard
  79 _
  80 MT-Level        Unsafe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBget_wch\fR(3XCURSES), \fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  87 \fBattributes\fR(5), \fBstandards\fR(5)