Share via

RemoteOrderDisplay.ClearVideoRegion Method

  • Article

2/27/2008

Clears the specified video region.

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

Syntax

'Declaration
Public MustOverride Sub ClearVideoRegion ( _
    row As Integer, _
    column As Integer, _
    height As Integer, _
    width As Integer, _
    attribute As VideoAttributes _
)

public abstract void ClearVideoRegion (
    int row,
    int column,
    int height,
    int width,
    VideoAttributes attribute
)

public:
virtual void ClearVideoRegion (
    int row, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute
) abstract

public abstract void ClearVideoRegion (
    int row, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute
)

public abstract function ClearVideoRegion (
    row : int, 
    column : int, 
    height : int, 
    width : int, 
    attribute : VideoAttributes
)

Parameters

  • row
    The region's start row.
  • column
    The region's start column.
  • height
    The number of rows in the region.
  • width
    The number of columns in the region.
  • attribute
    The attribute to clear.

Remarks

The display area is cleared by using the attribute put in the attribute parameter.

ClearVideoRegion is performed synchronously if AsyncMode is false, and asynchronously if AsyncMode is true.

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

Value

Description

Illegal

One of the following errors occurred:

  • row, column, height, or width are out of range.

  • The attribute parameter is illegal.

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 be returned only 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