Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
key_defined(3X)			 Library calls		       key_defined(3X)

NAME
       key_defined - test whether a curses keycode is defined

SYNOPSIS
       #include	<curses.h>

       int key_defined(const char *definition);

DESCRIPTION
       This  is	an extension to	the curses library.  It	permits	an application
       to determine if a string	is currently bound to any keycode.

RETURN VALUE
       If the string is	bound to a keycode, its	value (greater than  zero)  is
       returned.   If  no  keycode  is bound, zero is returned.	 If the	string
       conflicts with longer strings which are bound to	keys, -1 is returned.

PORTABILITY
       This routine is specific	to ncurses.  It	was not	supported  on  Version
       7,  BSD	or  System V implementations.  It is recommended that any code
       depending on them be conditioned	using NCURSES_VERSION.

AUTHORS
       Thomas Dickey

SEE ALSO
       define_key(3X)

ncurses	6.5			  2024-03-16		       key_defined(3X)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | PORTABILITY | AUTHORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=key_defined&sektion=3&manpath=FreeBSD+14.2-RELEASE+and+Ports>

home | help