Share via

RemoteOrderDisplay.CopyVideoRegion Method

  • Article

2/27/2008

Copies a region of the display area to a new location on the display area for the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub CopyVideoRegion ( _
    units As DeviceUnits, _
    row As Integer, _
    column As Integer, _
    height As Integer, _
    width As Integer, _
    targetRow As Integer, _
    targetColumn As Integer _
)

public abstract void CopyVideoRegion (
    DeviceUnits units,
    int row,
    int column,
    int height,
    int width,
    int targetRow,
    int targetColumn
)

public:
virtual void CopyVideoRegion (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    int targetRow, 
    int targetColumn
) abstract

public abstract void CopyVideoRegion (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    int targetRow, 
    int targetColumn
)

public abstract function CopyVideoRegion (
    units : DeviceUnits, 
    row : int, 
    column : int, 
    height : int, 
    width : int, 
    targetRow : int, 
    targetColumn : int
)

Parameters

  • units
    The video units to operate on.
  • 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.
  • targetRow
    The start row of the target location.
  • targetColumn
    The start column of the target location.

Remarks

The source area is defined by the row, column, height, and width parameters. The upper-left corner of the target location is defined by the targetRow and targetColumn parameters. If the ranges overlap the copy is performed in such a way that all original data is preserved.

This method is performed synchronously if AsyncMode is false, and asynchronously if AsyncMode is true.

CopyVideoRegion 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