Share via

RemoteOrderDisplay.ClearVideo Method

  • Article

2/27/2008

Clears the display area for the video unit(s) specified by the units parameter.

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

Syntax

'Declaration
Public MustOverride Sub ClearVideo ( _
    units As DeviceUnits, _
    attribute As VideoAttributes _
)

public abstract void ClearVideo (
    DeviceUnits units,
    VideoAttributes attribute
)

public:
virtual void ClearVideo (
    DeviceUnits units, 
    VideoAttributes attribute
) abstract

public abstract void ClearVideo (
    DeviceUnits units, 
    VideoAttributes attribute
)

public abstract function ClearVideo (
    units : DeviceUnits, 
    attribute : VideoAttributes
)

Parameters

  • units
    Indicates which unit(s) to operate on.
  • attribute
    The video attributes to clear.

Remarks

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

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

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

Value

Description

Illegal

One of the following errors occurred:

  • The attribute parameter is illegal.

  • The units parameter is zero or a nonexistent unit was specified.

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