11af1ac3341f66135d51c02dd4edf6cfbf0af29e
[ncurses.git] / doc / html / man / keybound.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>keybound</B> - return definition of keycode
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;curses.h&gt;</B>
14
15        <B>int</B> <B>keybound(int</B> <B>keycode,</B> <B>int</B> <B>count);</B>
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        This is an extension to the curses library.  It permits an
21        application to determine the string which  is  defined  in
22        the terminfo for specific keycodes.
23
24
25 </PRE>
26 <H2>RETURN VALUE</H2><PRE>
27        The  keycode  must  be  greater  than  zero,  else NULL is
28        returned.  If it does not correspond  to  a  defined  key,
29        then  NULL is returned.  Otherwise, the function returns a
30        string, which must be freed by the caller.
31
32
33 </PRE>
34 <H2>PORTABILITY</H2><PRE>
35        These routines are specific to  ncurses.   They  were  not
36        supported  on  Version 7, BSD or System V implementations.
37        It is recommended that any code depending on them be  con-
38        ditioned using NCURSES_VERSION.
39
40
41 </PRE>
42 <H2>SEE ALSO</H2><PRE>
43        <B><A HREF="define_key.3x.html">define_key(3x)</A></B>, <B><A HREF="keyok.3x.html">keyok(3x)</A></B>.
44
45
46 </PRE>
47 <H2>AUTHOR</H2><PRE>
48        Thomas Dickey.
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>