Share via

PosKeyboardBase.PosKeyEventType Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Holds the value of the key from the last DataEvent.

Namespace: Microsoft.PointOfService.BaseServiceObjects
Assembly: Microsoft.PointOfService.ControlBase (in microsoft.pointofservice.controlbase.dll)

Syntax

'Declaration
Public Overrides ReadOnly Property PosKeyEventType As KeyEvent

public override KeyEvent PosKeyEventType { get; }

public:
virtual property KeyEvent PosKeyEventType {
    KeyEvent get () override;
}

/** @property */
public KeyEvent get_PosKeyEventType ()

public override function get PosKeyEventType () : KeyEvent

Remarks

The value is defined as a logical key code in the upper 16 bits and a scan code in the lower 16 bits, where the values need not match a standard PC keyboard's values.

The application may treat the value of PosKeyData as device-independent, assuming that the system installer has configured the keyboard’s service object to translate internal key codes to the codes expected by the application. Such configuration is inherently service object-specific.

The PosKeyboardBase class verifies that the keyboard device has been opened, then retrieves the value of PosKeyboardProperties.PosKeyEventType.

The PosKeyboardProperties class initializes PosKeyboardProperties.PosKeyEventType to KeyEvent.Down. The service object updates PosKeyboardProperties.PosKeyEventType when the user presses or releases a key. If PosKeyboardProperties.PosKeyEventType is set to KeyEvent.Up and the PosKeyboardProperties.CapKeyUp property is set to false, the PosKeyboardProperties class throws an Illegal exception.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosKeyboardBase Class
PosKeyboardBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PosKeyboard.PosKeyEventType Property
PosKeyboard.CapKeyUp Property
KeyEvent Enumeration