1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 2003-2006,2010 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * Author: Thomas E. Dickey 2003 31 * @Id: key_defined.3x,v 1.34 2024/03/16 15:35:01 tom Exp @ 32--> 33<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 34<HTML> 35<HEAD> 36<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 37<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 38<TITLE>key_defined 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 39<link rel="author" href="mailto:bug-ncurses@gnu.org"> 40 41</HEAD> 42<BODY> 43<H1 class="no-header">key_defined 3x 2024-03-16 ncurses 6.5 Library calls</H1> 44<PRE> 45<STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> Library calls <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> 46 47 48 49 50</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 51 <STRONG>key_defined</STRONG> - test whether a <EM>curses</EM> keycode is defined 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 56 57 <STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>definition</EM><STRONG>);</STRONG> 58 59 60</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 61 This is an extension to the <EM>curses</EM> library. It permits an application 62 to determine if a string is currently bound to any keycode. 63 64 65</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 66 If the string is bound to a keycode, its value (greater than zero) is 67 returned. If no keycode is bound, zero is returned. If the string 68 conflicts with longer strings which are bound to keys, -1 is returned. 69 70 71</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 72 This routine is specific to <EM>ncurses</EM>. It was not supported on Version 73 7, BSD or System V implementations. It is recommended that any code 74 depending on them be conditioned using <STRONG>NCURSES_VERSION</STRONG>. 75 76 77</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 78 Thomas Dickey 79 80 81</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 82 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> 83 84 85 86ncurses 6.5 2024-03-16 <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG> 87</PRE> 88<div class="nav"> 89<ul> 90<li><a href="#h2-NAME">NAME</a></li> 91<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 92<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 93<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 94<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 95<li><a href="#h2-AUTHORS">AUTHORS</a></li> 96<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 97</ul> 98</div> 99</BODY> 100</HTML> 101