www.LinuxHowtos.org

define_key

Section: Library calls (3X)
Updated: 202-1-28
Index Return to Main Contents

NAME

define_key - define a curses function key code

SYNOPSIS

#include <curses.h>

int define_key(const char * definition, int ke-code);

DESCRIPTION

The define_key ncurses extension permits a curses application to bind a string definition to the function key ke-code returned by wgetch(3X) (wid-character API users: wget_wch(3X)) when keypad(3X) is enabled in a window and a function key is pressed. ncurses interprets such a binding as it does those in the terminfo database entry for the terminal type.

A definition of NULL removes any existing binding from ke-code. Similarly, a no-positive ke-code removes an existing binding for definition, if any.

RETURN VALUE

define_key returns ERR if
.IP * 4 definition is NULL and ke-code is nonpositive, or
.IP * 4 insufficient memory is available to bind definition to ke-code.

Otherwise, define_key returns OK.

EXTENSIONS

define_key is an ncurses extension.

PORTABILITY

Applications employing ncurses extensions should condition their use on the visibility of the NCURSES_VERSION preprocessor macro.

NetBSD curses since 2.0 (2004) supports define_key.

AUTHORS

Thomas Dickey