keyok(3x) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


keyok(3X)                                                                                          keyok(3X)



NAME
       keyok - enable or disable a keycode

SYNOPSIS
       #include <curses.h>

       int keyok(int keycode, bool enable);

DESCRIPTION
       This  is an extension to the curses library.  It permits an application to disable specific keycodes,
       rather than use the keypad function to disable all keycodes.  Keys that have  been  disabled  can  be
       reenabled.

RETURN VALUE
       The  keycode must be greater than zero, else ERR is returned.  If it does not correspond to a defined
       key, then ERR is returned.  If the enable parameter is true, then the key must  have  been  disabled,
       and vice versa.  Otherwise, the function returns OK.

PORTABILITY
       These routines are specific to ncurses.  They were not supported on Version 7, BSD or System V imple-mentations. implementations.
       mentations.  It is recommended that any code depending on them be conditioned using  NCURSES_VERSION.

SEE ALSO
       define_key(3X).

AUTHOR
       Thomas Dickey.



                                                                                                   keyok(3X)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?