UnloadStack method

Description

VWorks software calls the UnloadStack method to tell the plugin to release the stack at the specified location so the operator can remove the stack.

Syntax

 

HRESULT UnloadStack( [in] BSTR Labware, [in] enum PlateFlagsType PlateFlags, [in] BSTR Location, [out,retval] enum ReturnCode *retVal );

Parameters

 

Labware	[in] The labware name.
PlateFlags	[in] Specifies whether the labware has a lid, is sealed, or neither. Possible values: 0 = The labware does not have a lid and is not sealed 1 = The labware has a lid 2 = The labware is sealed
Location	[in] The name of the location of the stack.
retVal	[out, retval] Returns an error code. For more information, see “ReturnCode enumerated type” . Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL)

Related information

 

For information about...	See...
IsStackEmpty method	“IsStackEmpty method”
IsStackFull method	“IsStackFull method”
LoadStack method	“LoadStack method”
ReturnCode enumerated type	“ReturnCode enumerated type”
ScanStack method	“ScanStack method”
SinkPlate method	“SinkPlate method”
SourcePlate method	“SourcePlate method”