Aborted method

Event

A protocol run was aborted.

Description

VWorks software calls the Aborted method after a protocol run is aborted.

Syntax

 

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

Parameters

 

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

Aborted method input

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

Aborted element

The Aborted 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 Aborted method input

The following sample code is an Aborted XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the Aborted method. VWorks software tells the plugin that the protocol named Protocol File ‑ 1 was aborted.

 

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

Aborted method output

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

Example of Aborted method output

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

ProtocolFile - 1 was aborted.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='ProtocolFile - 1 was aborted. /> </Results> </HookResults> </Velocity11>

Related information

 

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