2 ****************************************************************************
3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 2003-2006,2010 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * Author: Thomas E. Dickey 2003
31 * @Id: key_defined.3x,v 1.36 2024/05/18 20:04:53 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>key_defined 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">key_defined 3x 2024-05-18 ncurses 6.5 Library calls</H1>
45 <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> Library calls <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>key_defined</STRONG> - test whether a <EM>curses</EM> function key code is defined
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>definition</EM><STRONG>);</STRONG>
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 The <STRONG>key_defined</STRONG> <EM>ncurses</EM> extension permits a <EM>curses</EM> application to
62 determine the function key code, if any, to which the string <EM>definition</EM>
66 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
67 <STRONG>key_defined</STRONG> returns the first key code to which <EM>definition</EM> is bound if
68 any exists. If none does, it returns <STRONG>0</STRONG>. If <EM>definition</EM> is a prefix of
69 another binding, <STRONG>key_defined</STRONG> returns <STRONG>-1</STRONG>.
72 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
73 <STRONG>define_key</STRONG> is an <EM>ncurses</EM> extension.
76 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
77 Applications employing <EM>ncurses</EM> extensions should condition their use on
78 the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
81 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
85 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
86 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
90 ncurses 6.5 2024-05-18 <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
94 <li><a href="#h2-NAME">NAME</a></li>
95 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
96 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
97 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
98 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
99 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
100 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
101 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>