ProtocolStarted method

Event

A protocol started.

Description

VWorks software calls the ProtocolStarted method after a protocol starts.

Syntax

 

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

Parameters

 

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

ProtocolStarted method input

VWorks software passes a ProtocolStarted XML element into the sXML parameter of the ProtocolStarted method. This XML element provides information about the protocol that started.

ProtocolStarted element

The ProtocolStarted 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
Simulating	Indicates whether the protocol is running in simulation mode. Possible values: 0 = The protocol is not running in simulation mode 1 = The protocol is running in simulation mode

Example of ProtocolStarted method input

The following sample code is a ProtocolStarted XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the ProtocolStarted method. VWorks software tells the plugin that the protocol named MyProtocol started in the Startup Protocol and that the protocol is running in simulation mode.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='f60b1a768f9a0cd259bde93752ce8201' version='1.0' > <ProtocolStarted Path='C:\V11\MyProtocol.pro' ProtocolType='1' Simulating='1' /> </Velocity11>

ProtocolStarted method output

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

Example of ProtocolStarted method output

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

MyProtocol.pro started.

 

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

Related information

 

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