BumpBar.CurrentUnitId Property

Article
10/07/2010

2/27/2008

Gets or sets the current bump bar unit ID.

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

Syntax

'Declaration
Public MustOverride Property CurrentUnitId As DeviceUnits

public abstract DeviceUnits CurrentUnitId { get; set; }

public:
virtual property DeviceUnits CurrentUnitId {
    DeviceUnits get () abstract;
    void set (DeviceUnits value) abstract;
}

/** @property */
public abstract DeviceUnits get_CurrentUnitId ()

/** @property */
public abstract void set_CurrentUnitId (DeviceUnits value)

public abstract function get CurrentUnitId () : DeviceUnits

public abstract function set CurrentUnitId (value : DeviceUnits)

Remarks

Some properties and methods apply only to the selected bump bar unit ID as noted. Up to 32 units are allowed for one bump bar device. The unit ID definitions range from Unit1 to Unit32 (replacing BB_UID_1 to BB_UID_32).

The following properties and methods apply only to the selected bump bar ID:

Properties: AutoToneDuration, AutoToneFrequency, BumpBarDataCount, CapTone, and Keys.

Setting the CurrentUnitId property updates these properties to the current values for the specified unit.
Methods: CheckHealth, ClearInput, ClearOutput.

CurrentUnitId is set and updated by the service object while the device is enabled.

Accessing CurrentUnitId can cause general exceptions to be thrown and a PosControlException with the following specific ErrorCode.

Value	Meaning
Illegal	An illegal unit ID was specified. The ErrorCodeExtended property is 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.

Share via

BumpBar.CurrentUnitId Property

Syntax

Remarks

Thread Safety

See Also

Reference

Additional resources