SourcePlate method

Description

VWorks software calls the SourcePlate method to tell the plugin to downstack a labware from the specified location.

IMPORTANT VWorks software always called the ScanStack method before the SinkPlate or SourcePlate method. See “ScanStack method” and “SinkPlate method” .

Syntax

 

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

Parameters

 

Labware	[in] The labware type.
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
SourceFromLocation	[in] The name of the location of the stack from which the labware is to be downstacked.
retVal	[out, retval] Returns an error code. 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) For more information, see “ReturnCode enumerated type” .

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”
UnloadStack method	“UnloadStack method”