ncurses 6.2 - patch 20201205
[ncurses.git] / man / key_defined.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 2003-2006,2010 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 .\"
30 .\" Author: Thomas E. Dickey 2003
31 .\"
32 .\" $Id: key_defined.3x,v 1.10 2020/10/17 23:39:03 tom Exp $
33 .TH key_defined 3X ""
34 .SH NAME
35 \fBkey_defined\fP \- check if a keycode is defined
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fP
38 .sp
39 \fBint key_defined(const char *\fP\fIdefinition\fP\fB);\fP
40 .SH DESCRIPTION
41 This is an extension to the curses library.
42 It permits an application to determine if a string is currently bound
43 to any keycode.
44 .SH RETURN VALUE
45 If the string is bound to a keycode, its value (greater than zero) is returned.
46 If no keycode is bound, zero is returned.
47 If the string conflicts with longer strings
48 which are bound to keys, \-1 is returned.
49 .SH PORTABILITY
50 These routines are specific to ncurses.
51 They were not supported on
52 Version 7, BSD or System V implementations.
53 It is recommended that
54 any code depending on them be conditioned using NCURSES_VERSION.
55 .SH SEE ALSO
56 \fBdefine_key\fR(3X).
57 .SH AUTHOR
58 Thomas Dickey.