X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fkey_defined.3x.html;h=87278cacefce0fda28a3dde9e3cde6bc98e0b356;hb=HEAD;hp=62d52d18f0d6453d5e2e47c23a7eb9798409f04b;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86;p=ncurses.git diff --git a/doc/html/man/key_defined.3x.html b/doc/html/man/key_defined.3x.html index 62d52d18..8ef095ad 100644 --- a/doc/html/man/key_defined.3x.html +++ b/doc/html/man/key_defined.3x.html @@ -1,6 +1,7 @@ -
- --key_defined(3x) key_defined(3x) +key_defined(3x) Library calls key_defined(3x) --
- key_defined - check if a keycode is defined +
+ key_defined - test whether a curses function key code is defined --
+
#include <curses.h> - int key_defined(const char *definition); + int key_defined(const char * definition); --
- This is an extension to the curses library. It permits an - application to determine if a string is currently bound to - any keycode. +
+ The key_defined ncurses extension permits a curses application to + determine the function key code, if any, to which the string definition + is bound. --
- 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. +
+ 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 binding, key_defined returns -1. --
- 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 con- - ditioned using NCURSES_VERSION. +
+ define_key is an ncurses extension. --
- define_key(3x). +
+ Applications employing ncurses extensions should condition their use on + the visibility of the NCURSES_VERSION preprocessor macro. --
- Thomas Dickey. +
+ Thomas Dickey + + +
+ ncurses(3x), define_key(3x), keyok(3x), keybound(3x), keyok(3x) - key_defined(3x) +ncurses 6.5 2024-05-18 key_defined(3x)