ExportXML method

Description

VWorks software calls the ExportXML method to notify the plugin that the user is exporting a profile. VWorks software automatically includes the following data in the export file:

All registry keys located in the path HKEY_LOCAL_MACHINE\Velocity11\<RegistryName>\<ProfileName>

where

•	<RegistryName> is the value returned by the plugin in response to the GetMetaData method call (See IWorksDriver “GetMetaData method” )

•	<ProfileName> is the specified profile

By implementing the ExportXML method, the plugin can tell VWorks software to include additional profile data from registry locations, external files, or both in the export file.

IMPORTANT The plugin should not implement the IWorksProfiles interface if it has no additional profile data.

Syntax

 

HRESULT ExportXML( [in] BSTR ProfileName, [out,retval] BSTR *ExportInfo );

Parameters

 

ProfileName	[in] The name of the profile file that is being exported.
ExportInfo	[out, retval] A settings XML block, a files XML block, or both that specify additional registry settings and external files to be included in the export file.

ExportXML method output

The plugin returns a settings XML block, a files XML block, or both in the ExportInfo parameter of the ExportXML method.

XML structure

The value of the file attribute for the Velocity11 element is the name of the device whose profile is being exported. See “Velocity11 element” .

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <settings> <setting /> ... </settings> <files> <file /> ... </files> </Velocity11>

settings XML block

The settings XML block contains the settings element and all its children. This XML block specifies additional registry settings to be included in the export file for the specified profile.

settings element

The settings element contains one or more setting elements.

setting element

Each setting element specifies the folder path of a registry and the action to take. This element has the following attributes:

 

Name	Value
action	One of the following values: • CopyRegistryNode This value is used to copy the specified node and all its children to the export file • CopyRegistryValue This value is used to copy a single registry value to the export file
location	The relative path to the registry node containing the data to be copied. This path is appended to HKEY_LOCAL_MACHINE\Velocity11\<RegistryName>\ to form the absolute folder path.

files XML block

The files XML block contains the files element and all its children. This XML block specifies the external files to be included in the export file for the specified profile.

files element

The files element contains one or more file elements.

file element

Each file element specifies the name and location of an external file and the action to take. This element has the following attributes:

 

Name	Value
action	The value Copy.
entry	The name of the profile setting that contains the folder path of the external file.
location	The file path of the external file.

Examples of ExportXML method output

Registry settings

The following sample code is a settings XML block that is returned to VWorks software by the plugin as a string in the ExportInfo parameter of the ExportXML method. The code, which is returned by a Stacker, tells VWorks software to include the following data in the export file for the specified profile: the information contained in the Windows registry key located in the Stacker\settings\ folder.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='Stacker' md5sum='646194ae858821b0d32f3cd01631184f' →version='1.0.0' > <settings > <setting action='CopyRegistryNode' location='Stacker\settings\' /> </settings> </Velocity11>

External files

The following sample code is a files XML block that is returned to VWorks software by the plugin as a string in the ExportInfo parameter of the ExportXML method. The code, which is returned by a KiNEDx Robot, tells VWorks software to include three external files in the export file for the specified profile. The files are located in the C:\Program Files (x86)\Peak KiNEDx Robot Control DLL\ folder.

•	Parameters3088.ini

•	C12144 Teach Points 3088.ini

•	C12144 Waypoints 3088.wpt

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='KiNEDx Robot' md5sum='e21a1cbdc1c47f49a674722f4697849a' →version='1.0.0' > <files > <file action='Copy' entry='Parameters File' location='C:\Program Files →(x86)\Peak KiNEDx Robot Control DLL\Parameters3088.ini' /> <file action='Copy' entry='Teachpoints File' location='C:\Program Files →(x86)\Peak KiNEDx Robot Control DLL\C12144 Teach Points 3088.ini' /> <file action='Copy' entry='Waypoints File' location='C:\Program Files (x86)\Peak →KiNEDx Robot Control DLL\C12144 Waypoints 3088.wpt' /> </files> </Velocity11>