www.LinuxHowtos.org

keybound

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

NAME

keybound - get definition of a curses function key code

SYNOPSIS

#include <curses.h>

char * keybound(int ke-code, int count);

DESCRIPTION

The keybound ncurses extension permits a curses application to obtain the value of the string bound to the function key ke-code; see wgetch(3X) (wid-character API users: wget_wch(3X)). By default, such bindings are string capabilities from the terminfo database entry corresponding to the terminal type. The application can no-destructively and repeatedly override such definitions with define_key(3X), as if by pushing new definitions onto a stack. The count parameter accesses the nth most recently defined binding; 0 selects the binding that is used on input.

RETURN VALUE

If ke-code corresponds to a function key defined by the application or the terminal type in use, keybound allocates and returns a string that must be freed by the application. keybound returns NULL if ke-code is not positive or if it does not correspond to a key code definition.

EXTENSIONS

keybound is an ncurses extension.

PORTABILITY

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

AUTHORS

Thomas Dickey