summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/keyok.3x.html
blob: 1dbe4551dec8a6bc2c519462d48ed90bb1500454 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
74
75
76
77
78
79
80
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>keyok</B> - enable or disable a keycode


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;curses.h&gt;</B>

       <B>int</B> <B>keyok(int</B> <B>keycode,</B> <B>bool</B> <B>enable);</B>


</PRE>
<H2>DESCRIPTION</H2><PRE>
       This is an extension to the curses library.  It permits an
       application to disable specific keycodes, rather than  use
       the  <I>keypad</I>  function  to disable all keycodes.  Keys that
       have been disabled can be reenabled.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       The keycode  must  be  greater  than  zero,  else  ERR  is
       returned.   If  it  does  not correspond to a defined key,
       then ERR is returned.  If the <I>enable</I>  parameter  is  true,
       then  the  key  must  have  been disabled, and vice versa.
       Otherwise, the function returns OK.


</PRE>
<H2>PORTABILITY</H2><PRE>
       These routines are specific to  ncurses.   They  were  not
       supported  on  Version 7, BSD or System V implementations.
       It is recommended that any code depending on them be  con-
       ditioned using NCURSES_VERSION.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="define_key.3x.html">define_key(3x)</A></B>.


</PRE>
<H2>AUTHOR</H2><PRE>
       Thomas Dickey.






















</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>