ncurses 5.1
[ncurses.git] / doc / html / man / keyok.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>keyok</B> - enable or disable a 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>keyok(int</B> <B>keycode,</B> <B>bool</B> <B>enable);</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 disable specific keycodes, rather than  use
22        the  <I>keypad</I>  function  to disable all keycodes.  Keys that
23        have been disabled can be reenabled.
24
25
26 </PRE>
27 <H2>RETURN VALUE</H2><PRE>
28        The keycode  must  be  greater  than  zero,  else  ERR  is
29        returned.   If  it  does  not correspond to a defined key,
30        then ERR is returned.  If the <I>enable</I>  parameter  is  true,
31        then  the  key  must  have  been disabled, and vice versa.
32        Otherwise, the function returns OK.
33
34
35 </PRE>
36 <H2>PORTABILITY</H2><PRE>
37        These routines are specific to  ncurses.   They  were  not
38        supported  on  Version 7, BSD or System V implementations.
39        It is recommended that any code depending on them be  con-
40        ditioned using NCURSES_VERSION.
41
42
43 </PRE>
44 <H2>SEE ALSO</H2><PRE>
45        <B><A HREF="define_key.3x.html">define_key(3x)</A></B>.
46
47
48 </PRE>
49 <H2>AUTHOR</H2><PRE>
50        Thomas Dickey.
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>