keypad(3curses)

keypad -- enable/disable abbreviation of function keys

Synopsis

cc [options] file -lcurses

#include <curses.h>

int keypad(WINDOW *win, bool bf);

Description

The keypad(3curses) 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(3curses) returns OK. Otherwise, it returns ERR.

Errors

No errors are defined.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

``Keypad Processing'', curses(4)