xref: /illumos-gate/usr/src/man/man3xcurses/typeahead.3xcurses (revision 7014882c6a3672fd0e5d60200af8643ae53c5928)
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]
TYPEAHEAD 3XCURSES "Jun 5, 2002"
NAME
typeahead - check for type-ahead characters
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 typeahead(int fd);
PARAMETERS
fd

Is the file descriptor that is used to check for type-ahead characters.

DESCRIPTION

The typeahead() function specifies the file descriptor (fd) to use to check for type-ahead characters (characters typed by the user but not yet processed by X/Open Curses).

X/Open Curses checks for type-ahead characters periodically while updating the screen. If characters are found, the current update is postponed until the next refresh(3XCURSES) or doupdate(3XCURSES). This speeds up response to commands that have been typed ahead. Normally, the input file pointer passed to newterm(3XCURSES), or stdin in the case of initscr(3XCURSES), is used for type-ahead checking.

If fd is -1, no type-ahead checking is done.

RETURN VALUES

On success, the typeahead() function returns OK. Otherwise, it returns 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

doupdate(3XCURSES), getch(3XCURSES), initscr(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)