define_key(3) Library calls define_key(3)
NAME
define_key - define a curses keycode
SYNOPSIS
#include <curses.h>
define_key(3) char *definition, int keycode);
DESCRIPTION
This is an extension to the curses library. It permits an application
to define keycodes with their corresponding control strings, so that
the ncurses library will interpret them just as it would the predefined
codes in the terminfo database.
If definition is NULL, any existing one for the keycode is removed.
Similarly, if the given keycode is negative or zero, any existing
string for the given definition is removed.
RETURN VALUE
Either keycode must be greater than zero, or definition must be
non-NULL, otherwise ERR is returned. ERR may also be returned if there
is insufficient memory to allocate the data to store the definition.
If no error is detected, OK is returned.
PORTABILITY
These routines are specific to ncurses. They were not supported on
Version 7, BSD or System V implementations. It is recommended that any
code depending on them be conditioned using NCURSES_VERSION.
AUTHORS
Thomas Dickey
SEE ALSO
keyok(3X), key_defined(3X)
ncurses 6.5 2024-03-16 define_key(3)
ncurses 6.5 - Generated Sat May 4 13:33:50 CDT 2024