ncurses 6.0 - patch 20160820
[ncurses.git] / doc / html / man / define_key.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * Author: Thomas E. Dickey 1997
30   * @Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>define_key 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">define_key 3x</H1>
43 <PRE>
44 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>                                           <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>define_key</STRONG> - define a keycode
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition,</STRONG> <STRONG>int</STRONG> <STRONG>keycode);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        This is an extension to the curses library.  It permits an
61        application to define keycodes  with  their  corresponding
62        control  strings,  so that the ncurses library will inter-
63        pret them just as it would the  predefined  codes  in  the
64        terminfo database.
65
66        If  the  given string is null, any existing definition for
67        the keycode is removed.  Similarly, if the  given  keycode
68        is  negative  or  zero,  any existing string for the given
69        definition is removed.
70
71
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        The keycode must be greater than zero, and the string non-
74        null, otherwise ERR is returned.  ERR may also be returned
75        if there is insufficient memory to allocate  the  data  to
76        store  the  definition.   If  no  error is detected, OK is
77        returned.
78
79
80 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
81        These routines are specific to  ncurses.   They  were  not
82        supported  on  Version 7, BSD or System V implementations.
83        It is recommended that any code depending on them be  con-
84        ditioned using NCURSES_VERSION.
85
86
87 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
88        <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>.
89
90
91 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
92        Thomas Dickey.
93
94
95
96                                                          <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
97 </PRE>
98 <div class="nav">
99 <ul>
100 <li><a href="#h2-NAME">NAME</a></li>
101 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
102 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
103 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
104 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
105 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
106 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
107 </ul>
108 </div>
109 </BODY>
110 </HTML>