ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / define_key.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * Author: Thomas E. Dickey 1997
31   * @Id: define_key.3x,v 1.17 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
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</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">define_key 3x</H1>
44 <PRE>
45 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>                                                  <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>define_key</STRONG> - define a keycode
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition,</STRONG> <STRONG>int</STRONG> <STRONG>keycode);</STRONG>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        This  is an extension to the curses library.  It permits an application
62        to define keycodes with their corresponding control  strings,  so  that
63        the ncurses library will interpret them just as it would the predefined
64        codes in the terminfo database.
65
66        If the given string is null, any existing definition for the keycode is
67        removed.   Similarly,  if  the  given  keycode is negative or zero, any
68        existing string for the given definition is removed.
69
70
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72        The keycode must be greater than zero, and the string non-null,  other-
73        wise  <STRONG>ERR</STRONG>  is  returned.  <STRONG>ERR</STRONG> may also be returned if there is insuffi-
74        cient memory to allocate the data to store the definition.  If no error
75        is detected, <STRONG>OK</STRONG> is returned.
76
77
78 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
79        These  routines  are  specific  to ncurses.  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 NCURSES_VERSION.
82
83
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>.
86
87
88 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
89        Thomas Dickey.
90
91
92
93                                                                 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
94 </PRE>
95 <div class="nav">
96 <ul>
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>
104 </ul>
105 </div>
106 </BODY>
107 </HTML>