RobotPlaceComplete method

Event

A robot placed a labware.

Description

VWorks software calls the RobotPlaceComplete method to notify the plugin that a robot placed a labware.

Syntax

 

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

Parameters

 

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

RobotPlaceComplete method input

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

Example of RobotPlaceComplete method input

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

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='a87004731e03b5c901b140e181e9742a' version='1.0' > <RobotPlaceComplete /> </Velocity11>

RobotPlaceComplete method output

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

Example of RobotPlaceComplete 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 RobotPlaceComplete method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

A plate is placed.

 

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