Share via

BumpBar.SetKeyTranslation Method

  • Article

2/27/2008

Assigns a logical key value to key scan code.

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

Syntax

'Declaration
Public MustOverride Sub SetKeyTranslation ( _
    units As DeviceUnits, _
    scanCode As Integer, _
    logicalKey As Integer _
)

public abstract void SetKeyTranslation (
    DeviceUnits units,
    int scanCode,
    int logicalKey
)

public:
virtual void SetKeyTranslation (
    DeviceUnits units, 
    int scanCode, 
    int logicalKey
) abstract

public abstract void SetKeyTranslation (
    DeviceUnits units, 
    int scanCode, 
    int logicalKey
)

public abstract function SetKeyTranslation (
    units : DeviceUnits, 
    scanCode : int, 
    logicalKey : int
)

Parameters

  • units
    Bitwise mask that indicates which bump bar unit(s) to set key translation for.
  • scanCode
    The bump bar generated key scan code. Valid values 0-255.
  • logicalKey
    The translated logical key value. Valid values 0-255.

Remarks

SetKeyTranslation assigns a logical key value to a device-specific key scan code for the bump bar unit(s) specified by the units parameter. The logical key value is used during translation during the DataEvent.

SetKeyTranslation may cause a PosControlException to be thrown with the following ErrorCodes.

Value

Meaning

Illegal

One of the following errors occurred:

  • scanCode or logicalKey are out of range.

  • units is zero or a nonexistent unit was specified.

The DeviceErrorEventArgs and ErrorCodeExtended properties are updated before return.

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

BumpBar Class
BumpBar Members
Microsoft.PointOfService Namespace
ErrorUnits
ErrorString
DataEvent