2 ****************************************************************************
3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1999-2008,2010 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.38 2024/05/18 20:05:36 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>keybound 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
43 <H1 class="no-header">keybound 3x 2024-05-18 ncurses 6.5 Library calls</H1>
45 <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> Library calls <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>keybound</STRONG> - get definition of a <EM>curses</EM> function key code
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <EM>key-code</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>count</EM><STRONG>);</STRONG>
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 The <STRONG>keybound</STRONG> <EM>ncurses</EM> extension permits a <EM>curses</EM> application to obtain
62 the value of the string <EM>bound</EM> to the function key <EM>key-code</EM>; see
63 <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> (wide-character API users: <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG>). By default, such
64 bindings are string capabilities from the <EM>terminfo</EM> database entry
65 corresponding to the terminal type. The application can non-
66 destructively and repeatedly override such definitions with
67 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, as if by pushing new definitions onto a stack. The
68 <EM>count</EM> parameter accesses the <EM>n</EM>th most recently defined binding; <STRONG>0</STRONG>
69 selects the binding that is used on input.
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73 If <EM>key-code</EM> corresponds to a function key defined by the application or
74 the terminal type in use, <STRONG>keybound</STRONG> allocates and returns a string that
75 must be freed by the application. <STRONG>keybound</STRONG> returns <STRONG>NULL</STRONG> if <EM>key-code</EM> is
76 not positive or if it does not correspond to a key code definition.
79 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
80 <STRONG>keybound</STRONG> is an <EM>ncurses</EM> extension.
83 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
84 Applications employing <EM>ncurses</EM> extensions should condition their use on
85 the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
88 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
92 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
93 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
97 ncurses 6.5 2024-05-18 <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
101 <li><a href="#h2-NAME">NAME</a></li>
102 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
103 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
104 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
105 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
108 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>