1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2<!-- 
3  ****************************************************************************
4  * Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
5  *                                                                          *
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:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
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.                               *
24  *                                                                          *
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       *
28  * authorization.                                                           *
29  ****************************************************************************
30  * Author: Thomas E. Dickey 1997
31  * @Id: keyok.3x,v 1.9 2006/02/25 21:47:06 tom Exp @
32-->
33<HTML>
34<HEAD>
35<TITLE>keyok 3x</TITLE>
36<link rev=made href="mailto:bug-ncurses@gnu.org">
37<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38</HEAD>
39<BODY>
40<H1>keyok 3x</H1>
41<HR>
42<PRE>
43<!-- Manpage converted by man2html 3.0.1 -->
44<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>                                                     <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
45
46
47
48
49</PRE>
50<H2>NAME</H2><PRE>
51       <STRONG>keyok</STRONG> - enable or disable a keycode
52
53
54</PRE>
55<H2>SYNOPSIS</H2><PRE>
56       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58       <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
59
60
61</PRE>
62<H2>DESCRIPTION</H2><PRE>
63       This is an extension to the curses library.  It permits an
64       application to disable specific keycodes, rather than  use
65       the  <EM>keypad</EM>  function  to disable all keycodes.  Keys that
66       have been disabled can be reenabled.
67
68
69</PRE>
70<H2>RETURN VALUE</H2><PRE>
71       The keycode  must  be  greater  than  zero,  else  ERR  is
72       returned.   If  it  does  not correspond to a defined key,
73       then ERR is returned.  If the <EM>enable</EM>  parameter  is  true,
74       then  the  key  must  have  been disabled, and vice versa.
75       Otherwise, the function returns OK.
76
77
78</PRE>
79<H2>PORTABILITY</H2><PRE>
80       These routines are specific to  ncurses.   They  were  not
81       supported  on  Version 7, BSD or System V implementations.
82       It is recommended that any code depending on them be  con-
83       ditioned using NCURSES_VERSION.
84
85
86</PRE>
87<H2>SEE ALSO</H2><PRE>
88       <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
89
90
91</PRE>
92<H2>AUTHOR</H2><PRE>
93       Thomas Dickey.
94
95
96
97                                                              <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
98</PRE>
99<HR>
100<ADDRESS>
101Man(1) output converted with
102<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
103</ADDRESS>
104</BODY>
105</HTML>
106