keybound.3x man page

keybound — return definition of keycode

Synopsis

#include <curses.h>

char * keybound(int keycode, int count);

Description

This is an extension to the curses library. It permits an application to determine the string which is defined in the terminfo for specific keycodes.

Return Value

The keycode parameter must be greater than zero, else NULL is returned. If it does not correspond to a defined key, then NULL is returned. The count parameter is used to allow the application to iterate through multiple definitions, counting from zero. When successful, the function returns a string which must be freed by the caller.

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.

See Also

define_key(3X), keyok(3X).

Author

Thomas Dickey.

Info