xHarbour Reference Documentation > Function Reference

HB_SetKeyCheck()

Evaluates a code block associated with a key.

Syntax

HB_SetKeyCheck( <nInkey> , ;
               [<param1>], ;
               [<param2>], ;
               [<param3>]  ) --> lIsSetkeyBlock

Arguments

<nInkey>

This is a numeric value representing the key code of the key associated with a code block. The key code is returned by the Inkey() function. To specify values for this parameter use #define constants from the file INKEY.CH.

<param1>..<param3>

Optionally, up to three arbitrary values can be specified. They are passed on to the code block associated with <nInkey>.

Return

The function returns .T. (true) when the key <nInkey> is associated with a code block and the code block is evaluated, otherwise .F. (false) is returned.

Description

The function tests if a key is associated with a code block. Key/code block associations are defined with the SetKey() function. When the key <nInkey> is associated with a code block, HB_SetKeyCheck() evaluates this code block and optionally passes up to three parameters on to it.

Info

See also:	Eval(), Inkey(), RestSetkey(), SaveSetkey(), SetKey()
Category:	Environment functions , Keyboard functions , xHarbour extensions
Source:	rtl\setkey.c
LIB:	xhb.lib
DLL:	xhbdll.dll