ProtocolFinished method

Event

A protocol is finished.

Description

VWorks software calls the ProtocolFinished method after a protocol is finished.

Syntax

 

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

Parameters

 

sXML	[in] A ProtocolFinished XML element containing information about the protocol that is finished.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

ProtocolFinished method input

VWorks software passes a ProtocolFinished XML element into the sXML parameter of the ProtocolFinished method. This XML element provides information about the protocol that is finished.

ProtocolFinished element

The ProtocolFinished 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.
ProtocolType	Represents the protocol type. Possible values: 1 = Startup 2 = Main 3 = Cleanup

Example of ProtocolFinished method input

The following sample code is a ProtocolFinished XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the ProtocolFinished method. VWorks software tells the plugin that the protocol named MyProtocol.pro is finished in the Cleanup Protocol.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='3b6461ce3a66ad5959be51ec7e40662b' version='1.0' > <ProtocolFinished Path='C:\V11\MyProtocol.pro' ProtocolType='3' /> </Velocity11>

ProtocolFinished method output

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

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

MyProtocol.pro is finished.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='MyProtocol.pro is finished.' /> </Results> </HookResults> </Velocity11>

Related information

 

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