1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1999-2003,2006 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 1999
31 * @Id: keybound.3x,v 1.6 2006/02/25 21:47:06 tom Exp @
35 <TITLE>keyok 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
51 <STRONG>keybound</STRONG> - return definition of keycode
55 <H2>SYNOPSIS</H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
62 <H2>DESCRIPTION</H2><PRE>
63 This is an extension to the curses library. It permits an
64 application to determine the string which is defined in
65 the terminfo for specific keycodes.
69 <H2>RETURN VALUE</H2><PRE>
70 The <EM>keycode</EM> parameter must be greater than zero, else NULL
71 is returned. If it does not correspond to a defined key,
72 then NULL is returned. The <EM>count</EM> parameter is used to
73 allow the application to iterate through multiple defini-
74 tions, counting from zero. When successful, the function
75 returns a string which must be freed by the caller.
79 <H2>PORTABILITY</H2><PRE>
80 These routines are specific to ncurses. They were not
81 supported on Version 7, BSD or System V implementations.
82 It is recommended that any code depending on them be con-
83 ditioned using NCURSES_VERSION.
87 <H2>SEE ALSO</H2><PRE>
88 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>.
97 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
101 Man(1) output converted with
102 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>