Deadlock method

Event

A deadlock occurred.

Description

VWorks software calls the Deadlock method after a deadlock occurs.

Syntax

 

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

Parameters

 

sXML	[in] A Deadlock XML element containing the file path to the protocol that generated the event.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

Deadlock method input

VWorks software passes a Deadlock XML element into the sXML parameter of the Deadlock method. This XML element provides the file path to the protocol that generated the event.

Deadlock element

The Deadlock element has the following attribute:

 

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.

Example of Deadlock method input

The following sample code is a Deadlock XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the Deadlock method. VWorks software tells the plugin that the protocol named Protocol File ‑ 1 encountered a deadlock during execution.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='19e8733a7594b5be747639772d28e706' version='1.0' > <Deadlock Path='Protocol File - 1' /> </Velocity11>

Deadlock method output

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

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

A deadlock occurred during execution of ProtocolFile - 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='A deadlock occurred during execution of ProtocolFile - 1.' /> </Results> </HookResults> </Velocity11>

Related information

 

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