ProtocolPaused method

Event

The scheduler is paused.

Description

After the scheduler is paused, VWorks software calls the ProtocolPaused method to notify the plugin of the state of the scheduler.

Syntax

 

HRESULT ProtocolPaused( [in] BSTR xXML, [in,out] BSTR* sResultXML );

Parameters

 

xXML	[in] A ProtocolPaused XML element that contains the state of the scheduler when VWorks software called this method.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

ProtocolPaused method input

VWorks software passes a ProtocolPaused XML element into the xXML parameter of the ProtocolPaused method. This XML element provides the state of the scheduler when VWorks software called the ProtocolPaused method.

ProtocolPaused element

The ProtocolPaused element has the following attribute:

 

Name	Value
PauseType	Represents the state of the scheduler. Possible values: 0 = Paused. The scheduler is paused, so protocols have temporarily stopped running. 1 = Continued. The scheduler is now running the previously paused protocols. 2 = Aborted. The scheduler is about to abort the currently running protocols. See “PauseType enumerated type” .

Example of ProtocolPaused method input

The following sample code is a ProtocolPaused XML element that is received by the plugin from VWorks software as a string in the xXML parameter of the ProtocolPaused method. VWorks software tells the plugin that the scheduler is paused, so protocols have temporarily stopped running.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='5ebe83f1832cae73ad07dfe9e6353bf3' version='1.0' > <ProtocolPaused PauseType='1' /> </Velocity11>

ProtocolPaused method output

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

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

The scheduler is paused.

 

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

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”
PauseType enumerated type	“PauseType enumerated type”