ncurses 4.2
[ncurses.git] / Ada95 / html / man / keyok.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>keyok</STRONG> - enable or disable a keycode
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
10
11        <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
12
13
14 </PRE>
15 <H2>DESCRIPTION</H2><PRE>
16        This is an extension to the curses library.  It permits an
17        application to disable specific keycodes, rather than  use
18        the  <EM>keypad</EM>  function  to disable all keycodes.  Keys that
19        have been disabled can be reenabled.
20
21
22 </PRE>
23 <H2>RETURN VALUE</H2><PRE>
24        The keycode  must  be  greater  than  zero,  else  ERR  is
25        returned.   If  it  does  not correspond to a defined key,
26        then ERR is returned.  If the <EM>enable</EM>  parameter  is  true,
27        then  the  key  must  have  been disabled, and vice versa.
28        Otherwise, the function returns OK.
29
30
31 </PRE>
32 <H2>PORTABILITY</H2><PRE>
33        These routines are specific to  ncurses.   They  were  not
34        supported  on  Version 7, BSD or System V implementations.
35        It is recommended that any code depending on them be  con-
36        ditioned using NCURSES_VERSION.
37
38
39 </PRE>
40 <H2>SEE ALSO</H2><PRE>
41        <STRONG><A HREF="define_key.3x.html">define_key(3X)</A></STRONG>.
42
43
44 </PRE>
45 <H2>AUTHOR</H2><PRE>
46        Thomas Dickey.
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68 </PRE>
69 </BODY>
70 </HTML>