RobotPickComplete method

Event

A robot picked up a labware.

Description

VWorks software calls the RobotPickComplete method to notify the plugin that a robot picked up a labware.

Syntax

 

HRESULT RobotPickComplete( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] An empty RobotPickComplete XML element.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

RobotPickComplete method input

VWorks software passes an empty RobotPickComplete XML element into the sXML parameter of the RobotPickComplete method.

Example of RobotPickComplete method input

The following sample code is an empty RobotPickComplete XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the RobotPickComplete method. VWorks software notifies the plugin that the robot picked up a labware.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='3c2d69b02b8e7505682cfb59c06a0105' version='1.0' > <RobotPickComplete /> </Velocity11>

RobotPickComplete method output

The plugin returns a HookResults XML block in the sResultXML parameter of the RobotPickComplete method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of RobotPickComplete method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the RobotPickComplete method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

A plate is picked up.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' ResultValue='A plate is picked up.' /> </Results> </HookResults> </Velocity11>