Defining export automation properties – Echelon LonWorks Network XML User Manual

Page 12

Advertising
background image

4

Using the LonMaker XML Plug-in

Defining Export Automation Properties

You can define standard LNS Plug-in properties and the following export automation properties in the
director application. See Appendix B of the LNS Plug-In Programmer’s Guide for more information
about the standard plug-in properties you can define.

Property Name

Type

Description

XmlFileName

BSTR

Specifies the path and name of the XML file to be created.
If a file with the specified name already exists, it will be
overwritten. If a name is not specified, the default name
will be as follows: <LM DB Dir >\XML\<network
name
>\Export[_index].XML.

<LM DB Dir> is the LonMaker drawing and database
directory. Typically, this is C:\LM.

<network name> is the name of the network being exported.

index is a decimal number appended to the file name or
incremented to make the file name unique.

The directory specified for the XML file must already exist.

XmlOptions

Long

Specifies export options. You can specify multiple options
by ORing the following values together:

&H01. Suppress status dialog. The XML plug-in does

not display a status dialog. The status dialog shows the
progress of the export operation and any errors
encountered.

&H02. Suppress options dialog. The XML plug-in

does not display an export options dialog. If you do not
set this option, you are prompted to specify the export
options (including whether to cancel the export).
Defaults for the options dialog are based on the
parameters sent to the plug-in.

&H10. Export NV values. Reports the values of the

NVs of all commissioned devices in the XML file.
This can significantly increase the time required to
export the XML file.

&H20. Export self-documentation. Reports

self-documentation data for commissioned devices in
the XML file. This can significantly increase the time
required to export the XML file.

&H40. Export device-specific CPs. Reports the values

of the device-specific CPs of commissioned devices in
the XML file. This can significantly increase the time
required to export the XML file.

ChannelExport Long Specifies

which

channels are reported in the exported XML

file. Specify one of the following options:

0. Reports all channels defined in the network. This is

the default.

1. Does not report any channels.
2. Reports only channels that are referenced in the

Advertising