GetPlatePresentResult method

Description

VWorks software calls the GetPlatePresentResult method to get the result of the last call to the CheckPlatePresent method from the plugin. See “CheckPlatePresent method” .

Syntax

 

HRESULT GetPlatePresentResult( [in] BSTR XML, [out] BSTR *returnedXML, [out,retval] enum ReturnCode *retVal );

Parameters

 

XML	[in] An empty IRobotDriver_GetPlatePresentResult_Input XML element.
returnedXML	[out] An IRobotDriver_GetPlatePresentResult_Output XML element that provides the result of the last call to the CheckPlatePresent method.
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” .

GetPlatePresentResult method input

VWorks software passes an empty IRobotDriver_GetPlatePresentResult_Input XML element into the XML parameter of the GetPlatePresentResult method.

Example of GetPlatePresentResult method input

The following sample code is an empty IRobotDriver_GetPlatePresentResult_Input XML element that is received by the plugin from VWorks software as a string in the XML parameter of the GetPlatePresentResult method. VWorks software asks the plugin for the result of the last call to the CheckPlatePresent method.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='0e237893b059fefa2b1edfdfad089f74' version='1.0' > <IRobotDriver_GetPlatePresentResult_Input /> </Velocity11>

GetPlatePresentResult method output

The plugin returns an IRobotDriver_GetPlatePresentResult_Output XML element in the returnedXML parameter of the GetPlatePresentResult method. This XML element provides the result of the last call to the CheckPlatePresent method. (See “CheckPlatePresent method” .)

IRobotDriver_GetPlatePresentResult_Output element

The IRobotDriver_GetPlatePresentResult_Output element has the following attribute:

 

Name	Value
Present	Represents the result of the last call to the CheckPlatePresent method. Possible values: 0 = The labware is not present 1 = The labware is present Required: No Default value: 0

Example of GetPlatePresentResult method output

The following sample code is an IRobotDriver_GetPlatePresentResult_Output XML element that is returned by the plugin to VWorks software as a string in the returnedXML parameter of the GetPlatePresentResult method. The plugin tells VWorks software that the result of the last CheckPlatePresent method call was 0 (The labware is not present).

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='c31697b858117fcc668453c48526698b' version='1.0' > <IRobotDriver_GetPlatePresentResult_Output Present='0' /> </Velocity11>

Related information

 

For information about...	See...
CheckPlatePresent method	“CheckPlatePresent method”
DelidRelid method	“DelidRelid method”
GetSimulationTimes method	“GetSimulationTimes method”
GetTeachPoints method	“GetTeachPoints method”
Move method	“Move method”
ReturnCode enumerated type	“ReturnCode enumerated type”
SetSpeed method	“SetSpeed method”