HasHotKey Method of the Commands Object

HasHotKey method of the Commands Object in ABBYY FineReader Engine Visual Components on Windows — This method allows you to find out whether the hot key is used by some command.

This method allows you to find out whether the hot key is used by some command. You can use this method to check availability of a hot key before registering a custom command.

Syntax

C++

HRESULT HasHotKey(
  int           HotKey,
  VARIANT_BOOL* Result
);

C#

bool HasHotKey( int HotKey );

Visual Basic .NET

Function HasHotKey(HotKey As Integer) As Boolean

Parameters

HotKey

[in] Specifies the hot key which should be checked. The parameter has the same format as the returned value (LRESULT) of the Windows SendMessage function for the HKM_GETHOTKEY message sent. To obtain the hot key value in this format, you should pack the virtual key code of the hot key to the low-order byte of the value, and the key modifier that specifies the keys that define a hot key combination to the high-order byte.

Result

[out, retval] Specifies whether the hot key is used by some command. If the value is TRUE, some command uses this hot key, and you cannot use the hot key for another command.

Return values

This method has no specific return values. It returns the standard return values of the ABBYY FineReader Engine functions.

See also

Commands