NAME
keypad — enable/disable abbreviation of function keys
SYNOPSIS
#include <curses.h>
int keypad(WINDOW *win, bool bf);
DESCRIPTION
The
keypad()
function controls keypad translation.
If bf is TRUE, keypad translation is turned on.
If bf is FALSE, keypad translation is turned off.
The initial state is FALSE.
This function affects the behaviour of any function that provides
keyboard input.
If the terminal in use requires a command to enable it to transmit distinctive
codes when a function key is pressed, then after keypad translation is first
enabled, the implementation transmits this command to the terminal before an
affected input function tries to read any characters from that terminal.
RETURN VALUE
Upon successful completion,
keypad()
returns OK. Otherwise, it returns ERR.
ERRORS
No errors are defined.
CHANGE HISTORY
First released in X/Open Curses, Issue 2.
X/Open Curses, Issue 4
The entry is rewritten for clarity.
Printable version
