Share via

RemoteOrderDisplay.CurrentUnitId Property

  • Article

2/27/2008

Gets or sets the current video unit ID. Up to 32 units are allowed on one remote order display device. The unit ID definitions range from Unit1 to Unit32.

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

The following properties and methods apply only to the selected video unit ID:

Properties: AutoToneDuration, AutoToneFrequency, CapSelectCharacterSet, CapTone, CapTouch, CharacterSet, CharacterSetList, Clocks, VideoDataCount, VideoMode, VideoModesList, VideoSaveBuffers.

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

Methods: CheckHealth, ClearInput, ClearOutput.

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

Accessing CurrentUnitID may cause a PosControlException to be thrown with the following ErrorCode:

Value

Description

Illegal

An illegal unit ID was specified. The ErrorString 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.

See Also

Reference

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace