2 ****************************************************************************
3 * Copyright (c) 1999-2008,2010 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * Author: Thomas E. Dickey 1999
30 * @Id: keybound.3x,v 1.8 2010/12/04 18:49:20 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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>keybound 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">
42 <H1 class="no-header">keybound 3x</H1>
44 <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>keybound</STRONG> - return definition of keycode
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
56 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
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 determine the string which is defined in
62 the terminfo for specific keycodes.
65 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
66 The <EM>keycode</EM> parameter must be greater than zero, else NULL
67 is returned. If it does not correspond to a defined key,
68 then NULL is returned. The <EM>count</EM> parameter is used to
69 allow the application to iterate through multiple defini-
70 tions, counting from zero. When successful, the function
71 returns a string which must be freed by the caller.
74 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
75 These routines are specific to ncurses. They were not
76 supported on Version 7, BSD or System V implementations.
77 It is recommended that any code depending on them be con-
78 ditioned using NCURSES_VERSION.
81 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
82 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>.
85 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
90 <STRONG><A HREF="keybound.3x.html">keybound(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-PORTABILITY">PORTABILITY</a></li>
99 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
100 <li><a href="#h2-AUTHOR">AUTHOR</a></li>