X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=df5fd13fcbfb5cabfe35ddd70fa46660e83aa7ab;hp=0be1e0002120130e9664b0936b075836a75504f4;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 0be1e000..df5fd13f 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,7 +1,6 @@ - +
+ +- +define_key(3x) define_key(3x) --
+ + + +
define_key - define a keycode --
+
#include <curses.h> - int define_key(char *definition, int keycode); + int define_key(const char *definition, int keycode); --
+
This is an extension to the curses library. It permits an application to define keycodes with their corresponding control strings, so that the ncurses library will inter- @@ -68,52 +69,42 @@ definition is removed. --
- The keycode must be greater than zero, else ERR is +
+ The keycode must be greater than zero, and the string non- + null, otherwise ERR is returned. ERR may also be returned + if there is insufficient memory to allocate the data to + store the definition. If no error is detected, OK is returned. --
- 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- +
+ 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. --
- keyok(3x). +
+ keyok(3x), key_defined(3x). --
+
Thomas Dickey. - - - - - - - - - - - - - - - - + define_key(3x)-