Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

typeahead(3XCURSES)

Name

typeahead - check for type-ahead characters

Synopsis

cc [ flag... ] file... –I /usr/xpg4/include –L /usr/xpg4/lib \
–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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard

See Also

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