ncurses 6.1 - patch 20190518
[ncurses.git] / doc / html / man / keyok.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * Author: Thomas E. Dickey 1997
30   * @Id: keyok.3x,v 1.13 2018/07/28 21:34:56 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>keyok 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">keyok 3x</H1>
43 <PRE>
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><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>keyok</STRONG> - enable or disable a keycode
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        This  is an extension to the curses library.  It permits an application
61        to disable specific keycodes, rather than use the  <EM>keypad</EM>  function  to
62        disable all keycodes.  Keys that have been disabled can be re-enabled.
63
64
65 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
66        The  keycode  must  be  greater than zero, else <STRONG>ERR</STRONG> is returned.  If it
67        does not correspond to a defined key, then <STRONG>ERR</STRONG>  is  returned.   If  the
68        <EM>enable</EM>  parameter  is  true,  then the key must have been disabled, and
69        vice versa.  Otherwise, the function returns <STRONG>OK</STRONG>.
70
71
72 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
73        These routines are specific to ncurses.  They  were  not  supported  on
74        Version 7, BSD or System V implementations.  It is recommended that any
75        code depending on them be conditioned using NCURSES_VERSION.
76
77
78 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
79        <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
80
81
82 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
83        Thomas Dickey.
84
85
86
87                                                                      <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
88 </PRE>
89 <div class="nav">
90 <ul>
91 <li><a href="#h2-NAME">NAME</a></li>
92 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
93 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
94 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
95 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
96 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
97 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
98 </ul>
99 </div>
100 </BODY>
101 </HTML>