jcs.org
jcs's openbsd hax
openbsd
1.\" $OpenBSD: key_defined.3,v 1.2 2023/10/17 09:52:08 nicm Exp $
2.\"
3.\"***************************************************************************
4.\" Copyright 2018-2021,2022 Thomas E. Dickey *
5.\" Copyright 2003-2006,2010 Free Software Foundation, Inc. *
6.\" *
7.\" Permission is hereby granted, free of charge, to any person obtaining a *
8.\" copy of this software and associated documentation files (the *
9.\" "Software"), to deal in the Software without restriction, including *
10.\" without limitation the rights to use, copy, modify, merge, publish, *
11.\" distribute, distribute with modifications, sublicense, and/or sell *
12.\" copies of the Software, and to permit persons to whom the Software is *
13.\" furnished to do so, subject to the following conditions: *
14.\" *
15.\" The above copyright notice and this permission notice shall be included *
16.\" in all copies or substantial portions of the Software. *
17.\" *
18.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25.\" *
26.\" Except as contained in this notice, the name(s) of the above copyright *
27.\" holders shall not be used in advertising or otherwise to promote the *
28.\" sale, use or other dealings in this Software without prior written *
29.\" authorization. *
30.\"***************************************************************************
31.\"
32.\" Author: Thomas E. Dickey 2003
33.\"
34.\" $Id: key_defined.3,v 1.2 2023/10/17 09:52:08 nicm Exp $
35.TH key_defined 3 2022-02-12 "ncurses 6.4" "Library calls"
36.SH NAME
37\fBkey_defined\fP \- check if a keycode is defined
38.SH SYNOPSIS
39\fB#include <curses.h>\fP
40.sp
41\fBint key_defined(const char *\fIdefinition\fB);\fR
42.SH DESCRIPTION
43This is an extension to the curses library.
44It permits an application to determine if a string is currently bound
45to any keycode.
46.SH RETURN VALUE
47If the string is bound to a keycode, its value (greater than zero) is returned.
48If no keycode is bound, zero is returned.
49If the string conflicts with longer strings
50which are bound to keys, \-1 is returned.
51.SH PORTABILITY
52These routines are specific to ncurses.
53They were not supported on
54Version 7, BSD or System V implementations.
55It is recommended that
56any code depending on them be conditioned using NCURSES_VERSION.
57.SH SEE ALSO
58\fBdefine_key\fP(3).
59.SH AUTHOR
60Thomas Dickey.