Share via

RemoteOrderDisplay.SaveVideoRegion Method

  • Article

2/27/2008

Saves the specified video region of the display area to one of the provided video buffers for the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub SaveVideoRegion ( _
    units As DeviceUnits, _
    row As Integer, _
    column As Integer, _
    height As Integer, _
    width As Integer, _
    bufferId As Integer _
)

public abstract void SaveVideoRegion (
    DeviceUnits units,
    int row,
    int column,
    int height,
    int width,
    int bufferId
)

public:
virtual void SaveVideoRegion (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    int bufferId
) abstract

public abstract void SaveVideoRegion (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    int bufferId
)

public abstract function SaveVideoRegion (
    units : DeviceUnits, 
    row : int, 
    column : int, 
    height : int, 
    width : int, 
    bufferId : int
)

Parameters

  • units
    The units to operate on.
  • row
    The start row of the region to save.
  • column
    The start column of the region to save.
  • height
    The number of rows in the region to save.
  • width
    The number of columns in the region to save.
  • bufferId
    Number identifying the video buffer to use. Valid values range from 1 to the VideoSaveBuffers property for a selected unit(s).

Remarks

The number of video buffers supported is stored in the VideoSaveBuffers property for each video unit online. However, an exception will be thrown if the requested buffer exceeds the number of SystemVideoSaveBuffers even though the VideoSaveBuffers property may indicated the unit can support more save buffers than currently allocated for that unit.

If VideoSaveBuffers is greater than 0, the service can support at a minimum one whole video screen. This does not guarantee that the service can save a whole video screen in each supported buffer for a single unit. An exception is raised when all the buffer memory has been allocated for a specific unit.

The source area is defined by the row, column, height, and width parameters. The video region can be restored to the screen by calling the RestoreVideoRegion method. If SaveVideoRegion is called two times with the same bufferId, the previous video data is lost, and any allocated memory is returned to the system.

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

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

Value

Description

Illegal

bufferId, row, column, height, or width is out of range. The ErrorUnits and ErrorString properties are updated.

ExtendedErrorNoBuffers

Requested buffer exceeds the number of SystemVideoSaveBuffers.

ExtendedErrorNoRoom

All the buffer memory has been allocated for a specific unit. The ErrorUnits and ErrorString properties are updated.

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
SystemVideoSaveBuffers
VideoSaveBuffers
RemoteOrderDisplay.RestoreVideoRegion Method