X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fkey_defined.3x.html;h=87278cacefce0fda28a3dde9e3cde6bc98e0b356;hb=HEAD;hp=df08a33d0ec9306519abe9493906a4ee0db9dc11;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/key_defined.3x.html b/doc/html/man/key_defined.3x.html index df08a33d..5b0c30fe 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 2024-06-08 ncurses 6.5 Library calls + + -

key_defined 3x

-
+

key_defined 3x 2024-06-08 ncurses 6.5 Library calls

-key_defined(3x)                                         key_defined(3x)
+key_defined(3x)                  Library calls                 key_defined(3x)
 
 
 
 
-
-

NAME

-       key_defined - check if a keycode is defined
+

NAME

+       key_defined - test whether a curses function key code is defined
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
-       int key_defined(const char *definition);
+       int key_defined(const char * definition);
 
 
-
-

DESCRIPTION

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

DESCRIPTION

+       The  key_defined  ncurses  extension  permits  a  curses application to
+       determine the function key code, if any, to which the string definition
+       is bound.
 
 
-
-

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

RETURN VALUE

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

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

EXTENSIONS

+       define_key is an ncurses extension.
 
 
-
-

SEE ALSO

-       define_key(3x).
+

PORTABILITY

+       Applications employing ncurses extensions should condition their use on
+       the visibility of the NCURSES_VERSION preprocessor macro.
 
 
-
-

AUTHOR

-       Thomas Dickey.
+

AUTHORS

+       Thomas Dickey
+
+
+

SEE ALSO

+       curses(3x), define_key(3x), keybound(3x), keyok(3x)
 
 
 
-                                                        key_defined(3x)
+ncurses 6.5                       2024-06-08                   key_defined(3x)