This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

key_defined(3X)                                                                              key_defined(3X)



NAME
       key_defined - check if a keycode is defined

SYNOPSIS
       #include <curses.h>

       int key_defined(const char *definition);

DESCRIPTION
       This  is  an  extension to the curses library.  It permits an application to determine if a string is
       currently bound to any keycode.

RETURN VALUE
       If the string is bound to a keycode, its value (greater than zero) is returned.   If  no  keycode  is
       bound,  zero is returned.  If the string conflicts with longer strings which are bound to keys, -1 is
       returned.

PORTABILITY
       These routines are specific to ncurses.  They were not supported on Version 7, BSD or System V imple-mentations. implementations.
       mentations.   It is recommended that any code depending on them be conditioned using NCURSES_VERSION.

SEE ALSO
       define_key(3X).

AUTHOR
       Thomas Dickey.



                                                                                             key_defined(3X)