Echelon LNS Plug-in User Manual

Page 23

Advertising
background image

5. Add a PluginInfo public static property that returns a reference to a PluginInfo object that

describes your plug-in. For efficiency, you should return a reference to a previously created
read-only object (for example, using a statically initialized field) instead of creating a new instance
each time.

The PluginInfo object provides the registration information for the plug-in that will be written to
the Windows registry for access by directors. The following table lists the fields of the
PluginInfo class and indicates whether each field is required or optional:

Field Description

PluginName

Unique identifying name of the plug-in. Used as the Windows
Registry key for the plug-in. For example, for the Echelon
LonPoint plug-in, this is “EchelonLonPointConfiguration”.

Required

Description

Description of the plug-in that is displayed by directors. This
information is typically displayed in a tooltip or status bar. For
example, for the Echelon LonPoint plug-in, this is “Echelon
LonPoint Configuration”.

Required

LcaVersion

Minimum version of LNS Object Server that this plug-in
requires. This must be 3.22 or higher because the LNS Plug-in
Framework does not support LNS releases prior to LNS Turbo
Service Pack 2 (3.22).

The version number is specified as <major release>.<minor
release>. The minor release should contain two digits; however,
it can contain either one or two digits. If the minor release
contains only one digit, it is assumed that the second digit is a
zero. This means that “3.2” is assumed to mean “3.20.”

Required

ManufacturerName

Name of the plug-in manufacturer, which may be displayed by
directors.

Required

Name

Name of the plug-in as displayed to the user by directors.
Typically a director will display this name in a menu. The
standard name for the registration action is <company> <plug-in
name>, such as "The Plug-in Company Sample Plug-in." For
example, for the Echelon LonPoint plug-in, this is “Echelon
LonPoint Configuration”.

Required

Scope

The scope at which the plug-in should be registered. This is
known as the plug-in scope or registration scope. This must be
set to ComponentAppScope.System. This should not be
confused with command scope (see the Glossary in Appenidx E
for details).

Required

Version

The version number of this plug-in. The version number is in the
same format as LcaVersion.

Required

Advertising