xref: /illumos-gate/usr/src/man/man3xcurses/ungetch.3xcurses (revision cd61ae21816e53b94bc1673f3f1aa651fc3115e8)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
UNGETCH 3XCURSES "Jun 5, 2002"
NAME
ungetch, unget_wch - push character back onto the input queue
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int ungetch(int ch);

int unget_wch(const wchar_t wch);
PARAMETERS
ch

Is the single byte character to be put back in the input queue for the next call to getch(3XCURSES).

wch

Is the wide character to be put back in the input queue for the next call to get_wch(3XCURSES).

DESCRIPTION

The ungetch() function pushes ch back onto the input queue until the next call to getch().

The unget_wch() function is similar to ungetch() except that ch can be of type wchar_t.

RETURN VALUES

On success, these functions return OK. Otherwise, they return ERR.

ERRORS

None.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

get_wch(3XCURSES), getch(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)