X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=edd87217f95af19243e6650148f103649dd0cb14;hp=0be1e0002120130e9664b0936b075836a75504f4;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 0be1e000..edd87217 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,7 +1,7 @@ - - + + + define_key 3x - + -

define_key 3x

-
+

define_key 3x

-
-
-
-

NAME

-       define_key - define a keycode
-
-
-
-

SYNOPSIS

-       #include <curses.h>
-
-       int define_key(char *definition, int keycode);
-
-
-
-

DESCRIPTION

-       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-
-       pret them just as it would the  predefined  codes  in  the
-       terminfo database.
-
-       If  the  given string is null, any existing definition for
-       the keycode is removed.  Similarly, if the  given  keycode
-       is  negative  or  zero,  any existing string for the given
-       definition is removed.
-
-
-
-

RETURN VALUE

-       The keycode  must  be  greater  than  zero,  else  ERR  is
-       returned.
+define_key(3x)                                                  define_key(3x)
 
 
-
-

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 con-
-       ditioned using NCURSES_VERSION.
-
-
-
-

SEE ALSO

-       keyok(3x).
-
-
-
-

AUTHOR

-       Thomas Dickey.
 
 
+

NAME

+       define_key - define a keycode
 
 
+

SYNOPSIS

+       #include <curses.h>
 
+       int define_key(const char *definition, int keycode);
 
 
+

DESCRIPTION

+       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 interpret them just as it would the predefined
+       codes in the terminfo database.
 
+       If the given string is null, any existing definition for the keycode is
+       removed.   Similarly,  if  the  given  keycode is negative or zero, any
+       existing string for the given definition is removed.
 
 
+

RETURN VALUE

+       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.
 
 
+

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.
 
 
+

SEE ALSO

+       keyok(3x), key_defined(3x).
 
 
+

AUTHOR

+       Thomas Dickey.
 
 
 
+                                                                define_key(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +