FileSaved method

Event

A protocol file, runset file, or device file was saved.

Description

VWorks software calls the FileSaved method when the user saves a protocol file, runset file, or device file.

Syntax

 

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

Parameters

 

sXML	[in] A FileSaved XML element that contains the file path of the saved file.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

FileSaved method input

VWorks software passes a FileSaved XML element into the sXML parameter of the FileSaved method. This XML element provides the file path of the file that was saved.

FileSaved element

The FileSaved element has the following attribute:

 

Name	Value
Path	The file path of the file that was saved.

Example of FileSaved method input

The following sample code is a FileSaved XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the FileSaved method. VWorks software tells the plugin that the protocol file named file1.pro located in the C:\V11\V11 Files\Protocols directory was saved.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='912539b6aeeb1373ffccab4d4983d456' version='1.0' > <FileSaved Path='C:\V11\V11 Files\Protocols\file1.pro' /> </Velocity11>

FileSaved method output

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

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

file1.pro was saved.

 

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

Related information

 

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