Share via

RemoteOrderDisplay.FreeVideoRegion Method

  • Article

2/27/2008

Frees any buffer memory allocated for the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub FreeVideoRegion ( _
    units As DeviceUnits, _
    bufferId As Integer _
)

public abstract void FreeVideoRegion (
    DeviceUnits units,
    int bufferId
)

public:
virtual void FreeVideoRegion (
    DeviceUnits units, 
    int bufferId
) abstract

public abstract void FreeVideoRegion (
    DeviceUnits units, 
    int bufferId
)

public abstract function FreeVideoRegion (
    units : DeviceUnits, 
    bufferId : int
)

Parameters

  • units
    The units to operate on.
  • bufferId
    Integer identifying the video buffer to free. Valid values range from 1 to the VideoSaveBuffers property for the selected unit(s).

Remarks

The number of video buffers supported is stored in the VideoSaveBuffers property for each video unit online. If the bufferId was never used in a previous SaveVideoRegion method, no action is taken.

FreeVideoRegion 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.

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
ErrorString
ErrorUnits
SaveVideoRegion
VideoSaveBuffers