BumpBar.CurrentUnitId Property

Selects the current bump bar unit ID.

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

Usage

'Usage
Dim bumpBar1 As BumpBar

Dim returnValue As DeviceUnits
returnValue = bumpBar1.CurrentUnitId

Dim sampleValue As DeviceUnits
bumpBar1.CurrentUnitId = sampleValue

Syntax

'Declaration
Public MustOverride Property CurrentUnitId() As DeviceUnits

public abstract DeviceUnits CurrentUnitId {get; set;}

public: property virtual DeviceUnits^ CurrentUnitId{
    DeviceUnits^ get();
    Void set(DeviceUnits^);
}

public abstract DeviceUnits get_CurrentUnitId();
public abstract void set_CurrentUnitId(DeviceUnits);

public abstract function get CurrentUnitId() : DeviceUnits;
public abstract function set CurrentUnitId(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, Keys.

  Setting CurrentUnitId updates these properties to the current values for the specified unit.

• Methods: CheckHealth, ClearInput, ClearOutput.

CurrentUnitId is typically initialized to Unit1. It should then be updated by the service object while the device is enabled.

Accessing CurrentUnitId can cause the following exception to be thrown:

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

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

BumpBar Class
BumpBar Members
Microsoft.PointOfService Namespace