1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 2003-2006,2010 Free Software Foundation, Inc. *
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: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
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. *
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 *
28 .\"***************************************************************************
30 .\" Author: Thomas E. Dickey 2003
32 .\" $Id: key_defined.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
33 .TH key_defined 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
35 \fB\%key_defined\fP \-
36 test whether a \fIcurses\fR keycode is defined
39 \fB#include <curses.h>
41 \fBint key_defined(const char *\fIdefinition\fP);
44 This is an extension to the \fIcurses\fP library.
45 It permits an application to determine if a string is currently bound
48 If the string is bound to a keycode, its value (greater than zero) is returned.
49 If no keycode is bound, zero is returned.
50 If the string conflicts with longer strings
51 which are bound to keys, \-1 is returned.
53 This routine is specific to \fI\%ncurses\fP.
54 It was not supported on
55 Version 7, BSD or System V implementations.
56 It is recommended that
57 any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
61 \fB\%define_key\fP(3X)