KeyboardRemap.GetKey (byte, PLANES, byte, byte, KEYTYPE, KEYATTRIBUTE, MODIFIER, byte) Method

Gets the definition for an existing key on the selected embedded or attached keyboard.

Syntax

[C#]
public static void GetDefaultKey(
    byte keyboard,
    PLANES plane, 
    byte page, 
    byte usage, 
    out KEYTYPE keyType, 
    out KEYATTRIBUTE keyAttribute, 
    out MODIFIER modifier, 
    out byte value)
;

Parameters

keyboard
Indicates the keyboard to be affected by this operation:

plane
Indicates the plane whose key definition is targeted. See Honeywell.Mobility.Device.Keyboard.PLANES.

page
Page value needed to uniquely identify the key.

usage
Usage value needed to uniquely identify the key.

keyType
Determines the primary function for the key. See Honeywell.Mobility.Device.Keyboard.KEYTYPE.

keyAttribute
Modifies operation of the key. See Honeywell.Mobility.Device.Keyboard.KEYATTRIBUTE.

modifier
Reserved. Set to None.

value
Actual value of the key. Depends on keyType and keyAttribute values.

Exceptions

KeyboardRemapException

Remarks

If more than one external keyboard is attached to the computer, call GetKeyboardID to return the unique identifier for each attached keyboard.

More Information

KeyboardRemap Class