ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / keyok.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2010,2017 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.14 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>keyok 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">keyok 3x</H1>
44 <PRE>
45 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>                                                            <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>keyok</STRONG> - enable or disable a keycode
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        This  is an extension to the curses library.  It permits an application
62        to disable specific keycodes, rather than use the  <EM>keypad</EM>  function  to
63        disable all keycodes.  Keys that have been disabled can be re-enabled.
64
65
66 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
67        The  keycode  must  be  greater than zero, else <STRONG>ERR</STRONG> is returned.  If it
68        does not correspond to a defined key, then <STRONG>ERR</STRONG>  is  returned.   If  the
69        <EM>enable</EM>  parameter  is  true,  then the key must have been disabled, and
70        vice versa.  Otherwise, the function returns <STRONG>OK</STRONG>.
71
72
73 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
74        These routines are specific to ncurses.  They  were  not  supported  on
75        Version 7, BSD or System V implementations.  It is recommended that any
76        code depending on them be conditioned using NCURSES_VERSION.
77
78
79 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
80        <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
81
82
83 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
84        Thomas Dickey.
85
86
87
88                                                                      <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
89 </PRE>
90 <div class="nav">
91 <ul>
92 <li><a href="#h2-NAME">NAME</a></li>
93 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
94 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
95 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
96 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
97 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
98 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
99 </ul>
100 </div>
101 </BODY>
102 </HTML>