CompileComplete method

Event

A protocol was compiled.

Description

VWorks software calls the CompileComplete method after a protocol is compiled. The plugin tells VWorks software whether the protocol run should proceed if compiler errors occurred.

Syntax

 

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

Parameters

 

sXML	[in] A Velocity11 XML element containing the number of errors and warnings that occurred during the compilation.
sResultXML	[in] A Velocity11 XML element that contains the action to take if compiler errors occurred.

CompileComplete method input

VWorks software passes a Velocity11 XML element into the sXML parameter of the CompileComplete method. This XML element provides the number of errors and warnings that occurred during the compilation.

Velocity11 element

The Velocity11 element has the following attributes:

 

Name	Value
Errors	The number of errors that occurred when the protocol was compiled.
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.
Warnings	The number of warnings that occurred when the protocol was compiled.

Example of CompileComplete method input

The following sample code is a Velocity11 XML element that is received by the plugin from VWorks software in the sXML parameter of the CompileComplete method. VWorks software tells the plugin that no warnings or errors occurred when the protocol was compiled.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='02ed84e9c28dad9cb815334189ba49ca' version='1.0' > <CompileComplete Errors='0' Path='Protocol File - 1' Warnings='0' /> </Velocity11>

CompileComplete method output

The plugin returns a Velocity11 XML element in the sResultXML parameter of the CompileComplete method. This XML element provides the action to take if compiler error occurred.

Velocity11 element

The Velocity11 element has the following additional attribute:

 

Name	Value
Action	Indicates whether the protocol run should proceed if compiler errors occurred. Possible values: • AllowErrors Allow the protocol run to proceed. • Any non-empty string Do not allow the protocol run to proceed.

Example of CompileComplete method output

The following sample code is a Velocity11 XML element that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the CompileComplete method. The plugin tells VWorks software to allow the protocol to proceed, even if compiler errors occurred.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='849392019ca47102839e845113d11840' version='1.0' Action='AllowErrors' />