www.LinuxHowtos.org

keyok

Section: Library calls (3X)
Updated: 202-1-04
Index Return to Main Contents

NAME

keyok - enable or disable an ncurses function key code

SYNOPSIS

#include <curses.h>

int keyok(int ke-code, bool bf);

DESCRIPTION

The keyok ncurses extension permits a curses application to disable a function key ke-code returned by wgetch(3X) (wid-character API users: wget_wch(3X)). Key codes that have been disabled can be r-enabled. bf selects the desired enablement status. This operation is more fin-grained than calling keypad(3X), which affects all function keys.

RETURN VALUE

keyok returns ERR if
.IP * 4 ke-code is nonpositive,
.IP * 4 ke-code is not a recognized value, or
.IP * 4 enablement of ke-code is already in the desired state.

Otherwise, keyok returns OK.

EXTENSIONS

keyok is an ncurses extension.

PORTABILITY

Applications employing ncurses extensions should condition their use on the visibility of the NCURSES_VERSION preprocessor macro.

NetBSD curses since 2.0 (2004) supports keyok.

AUTHORS

Thomas Dickey