SinkPlate method

Description

VWorks software calls the SinkPlate method to tell the plugin to upstack a labware to the specified location.

If VWorks software calls the SourcePlate method next, VWorks software expects to retrieve the same labware. See “SourcePlate method” .

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

Syntax

 

HRESULT SinkPlate( [in] BSTR Labware, [in] enum PlateFlagsType PlateFlags, [in] BSTR SinkToLocation, [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
SinkToLocation	[in] The name of the location of the stack to which the labware is to be upstacked.
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”
SourcePlate method	“SourcePlate method”
UnloadStack method	“UnloadStack method”