key_defined(3X)                                              key_defined(3X)

NAME         top

       key_defined - check if a keycode is defined

SYNOPSIS         top

       #include <curses.h>

       int key_defined(const char *definition);

DESCRIPTION         top

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

RETURN VALUE         top

       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

PORTABILITY         top

       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         top


AUTHOR         top

       Thomas Dickey.

COLOPHON         top

       This page is part of the ncurses (new curses) project.  Information
       about the project can be found at 
       ⟨⟩.  If you have a
       bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨git://⟩ on 2018-02-02.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2018-01-30.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not part
       of the original manual page), send a mail to