Error method

Event

An error occurred in VWorks software.

Description

VWorks software calls the Error method after an error occurs, that is, the plugin returned a RETURN_FAIL error code. See “ReturnCode enumerated type” .

Syntax

 

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

Parameters

 

sXML	[in] An Error XML element containing information about the error that occurred in VWorks software.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

Error method input

VWorks software passes an Error XML element into the sXML parameter of the Error method. This XML element provides information about the error that occurred in VWorks software.

Error element

The Error element has the following attributes:

 

Name	Value
Path	The name of the protocol that generated the event. If the protocol has been saved, the value of this attribute is the protocol’s file path. If the protocol has not been saved, the value is the default protocol name.
Source	The source of the error.
Message	A text string that describes the error.
InstanceNumber	The labware instance number.
DeviceName	The device name.
LocationName	The name of the location on the device where the error occurred.
Profile	The profile name.
ProcessName	The labware name.

Example of Error method input

The following sample code is an Error XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the Error method. VWorks software passes information about an error that was generated by the plugin named Plugin ‑ 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='02ed84e9c28dad9cb815334189ba49ca' version='1.0' > <Error Path='Protocol File - 1' Source='Plugin - 1' Message='Error' InstanceNumber='1' DeviceName='Device - 1' LocationName='Location1' Profile='Profile1' ProcessName='Process - 1' /> </Velocity11>

Error method output

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

Example of Error 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 Error method. The plugin tells the scheduler to pause the runset. It also tells VWorks software to write the following Error-type message to the Main Log:

Unable to move to safe height at end of protocol.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0' > <HookResults> <Results> <HookResult ResultType='Log Error' ResultValue='Unable to move to safe height at end of protocol.' /> <HookResult ResultType='Pause Execution' ResultValue='True' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”