doc/html/man/key_defined.3x.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 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.6 2010/12/04 18:40:45 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>key_defined 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>key_defined 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>                                         <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>key_defined</STRONG> - check if a keycode is defined
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>key_defined(const</STRONG> <STRONG>char</STRONG> <STRONG>*definition);</STRONG>
  59
  60
  61 </PRE>
  62 <H2>DESCRIPTION</H2><PRE>
  63        This is an extension to the curses library.  It permits an
  64        application to determine if a string is currently bound to
  65        any keycode.
  66
  67
  68 </PRE>
  69 <H2>RETURN VALUE</H2><PRE>
  70        If  the  string  is bound to a keycode, its value (greater
  71        than zero) is returned.  If no keycode is bound,  zero  is
  72        returned.   If  the  string  conflicts with longer strings
  73        which are bound to keys, -1 is returned.
  74
  75
  76 </PRE>
  77 <H2>PORTABILITY</H2><PRE>
  78        These routines are specific to  ncurses.   They  were  not
  79        supported  on  Version 7, BSD or System V implementations.
  80        It is recommended that any code depending on them be  con-
  81        ditioned using NCURSES_VERSION.
  82
  83
  84 </PRE>
  85 <H2>SEE ALSO</H2><PRE>
  86        <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
  87
  88
  89 </PRE>
  90 <H2>AUTHOR</H2><PRE>
  91        Thomas Dickey.
  92
  93
  94
  95                                                         <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>
  96 </PRE>
  97 <HR>
  98 <ADDRESS>
  99 Man(1) output converted with
 100 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 101 </ADDRESS>
 102 </BODY>
 103 </HTML>