key_defined

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

---

 

NAME

key_defined - obtain key code for an ncurses function key definition  

SYNOPSIS

#include <curses.h>

int key_defined(const char * definition);

 

DESCRIPTION

The key_defined ncurses extension permits a curses application to determine the function key code, if any, to which the string definition is bound.  

RETURN VALUE

key_defined returns the first key code to which definition is bound if any exists. If none does, it returns 0. If definition is a prefix of another bound definition, key_defined returns -1.  

EXTENSIONS

key_defined 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  

SEE ALSO

curses(3X), define_key(3X), keybound(3X), keyok(3X)

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUE

EXTENSIONS

PORTABILITY

AUTHORS

SEE ALSO