key_defined(3x)

key_defined3x

Check if a keycode is defined

Usage

#include <curses.h>

int key_defined(const char *definition);

Overview

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 implementations. It is recommended that any code depending on them be conditioned using NCURSES_VERSION.

Releases

135 releases since Mac OS X 10.4; the text changed 3 times.

  1. 10.4–10.4.11
  2. 10.5–10.5.8
  3. 10.6–13.5
  4. 14.0–26.5

Author

Thomas Dickey.

From ncurses 79 in macOS 26.5. Parsed by carta from the page's man source.