RemoteOrderDisplay.UpdateVideoRegionAttribute Method

2/27/2008

Modifies the attribute on the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub UpdateVideoRegionAttribute ( _
    units As DeviceUnits, _
    attributeFunction As VideoAttributeCommand, _
    column As Integer, _
    height As Integer, _
    width As Integer, _
    attribute As VideoAttributes _
)

public abstract void UpdateVideoRegionAttribute (
    DeviceUnits units,
    VideoAttributeCommand attributeFunction,
    int column,
    int height,
    int width,
    VideoAttributes attribute
)

public:
virtual void UpdateVideoRegionAttribute (
    DeviceUnits units, 
    VideoAttributeCommand attributeFunction, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute
) abstract

public abstract void UpdateVideoRegionAttribute (
    DeviceUnits units, 
    VideoAttributeCommand attributeFunction, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute
)

public abstract function UpdateVideoRegionAttribute (
    units : DeviceUnits, 
    attributeFunction : VideoAttributeCommand, 
    column : int, 
    height : int, 
    width : int, 
    attribute : VideoAttributes
)

Parameters

• units
  The units to operate on.

• attributeFunction
  The attribute command.

• column
  The region’s start column.

• height
  The number of rows in the region.

• width
  The number of columns in the region.

• attribute
  The video attribute to use.

Remarks

When the attributeFunction parameter is set, the region's attributes are replaced with the new value in the attribute parameter; otherwise the attribute parameter is ignored and the region's attributes are modified.

The UpdateVideoRegionAttribute method is performed synchronously if the AsyncMode property is false, and asynchronously if the AsyncMode property is true.

UpdateVideoRegionAttribute may cause a PosControlException exception to be thrown with the following ErrorCode:

Value	Description
Failure	An error occurred while communicating with one of the video units specified by units. The ErrorUnits and ErrorString properties are updated before return. (Can only occur if AsyncMode is false.)

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
AsyncMode
ErrorString
ErrorUnits