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