2 ****************************************************************************
3 * Copyright 2018-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 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 1997
31 * @Id: define_key.3x,v 1.34 2023/09/23 23:04:14 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>define_key 3x 2023-09-23 ncurses 6.4 Library calls</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">define_key 3x 2023-09-23 ncurses 6.4 Library calls</H1>
45 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> Library calls <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>define_key</STRONG> - define a <EM>curses</EM> keycode
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>definition</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>keycode</EM><STRONG>);</STRONG>
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 This is an extension to the <EM>curses</EM> library. It permits an application
62 to define keycodes with their corresponding control strings, so that
63 the <EM>ncurses</EM> library will interpret them just as it would the predefined
64 codes in the terminfo database.
66 If <EM>definition</EM> is <STRONG>NULL</STRONG>, any existing one for the keycode is removed.
67 Similarly, if the given keycode is negative or zero, any existing
68 string for the given definition is removed.
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72 Either <EM>keycode</EM> must be greater than zero, or <EM>definition</EM> must be non-
73 <STRONG>NULL</STRONG>, otherwise <STRONG>ERR</STRONG> is returned. <STRONG>ERR</STRONG> may also be returned if there is
74 insufficient memory to allocate the data to store the definition. If
75 no error is detected, <STRONG>OK</STRONG> is returned.
78 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
79 These routines are specific to <EM>ncurses</EM>. They were not supported on
80 Version 7, BSD or System V implementations. It is recommended that any
81 code depending on them be conditioned using <STRONG>NCURSES_VERSION</STRONG>.
84 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
85 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
88 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
93 ncurses 6.4 2023-09-23 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
97 <li><a href="#h2-NAME">NAME</a></li>
98 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
99 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
100 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
101 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
102 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
103 <li><a href="#h2-AUTHOR">AUTHOR</a></li>