Current File : //usr/share/man/man3xcurses/ungetch.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH ungetch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
ungetch, unget_wch \- push character back onto the input queue
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBint\fR \fBungetch\fR(\fBint\fR \fIch\fR);
.fi

.LP
.nf
\fBint\fR \fBunget_wch\fR(\fBconst wchar_t\fR \fIwch\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIch\fR\fR
.ad
.RS 7n
.rt  
Is the single byte character to be put back in the input queue for the  next call to \fBgetch\fR(3XCURSES).
.RE

.sp
.ne 2
.mk
.na
\fB\fIwch\fR\fR
.ad
.RS 7n
.rt  
Is the wide character to be put back in the input queue for the next call  to \fBget_wch\fR(3XCURSES).
.RE

.SH DESCRIPTION
.sp
.LP
The \fBungetch()\fR function pushes \fIch\fR back onto the input queue until the next  call to \fBgetch()\fR.
.sp
.LP
The \fBunget_wch()\fR function is similar to \fBungetch()\fR except that \fIch\fR can be of type \fBwchar_t\fR.
.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBget_wch\fR(3XCURSES), \fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)