Echelon OpenLNS - Manual (Page 649)

OpenLNS Programmer's Reference 612
ProgrammaticName
Summary Returns the programmatic name of the network variable.
This property contains the orignal base name of the network
variable as "programmed" in the device containing the object.
•
For static network variables, OpenLNS initially acquires
the name from the functional profile template file or
external interface associated with the device.
• For dynamic network variables, you will specify the name
to use when you create the object with the appropriate
Add method.
Initially, the Name property, which represents the user name
of the network variable or network variable, will also be set
to the same value as the ProgrammaticName property. The
Name property can be subsequently changed for all network
variables, allowing OpenLNS applications to create their own
identifying names for those objects.
This property can be a maximum of 16 characters long, and
must conform to the character restrictions defined in version
3.3 and later of the LonMark Application Layer
Interoperability Guidelines. You may not use the following
characters in the ProgrammaticName property: the forward
slash (/), back slash (\), period (.), and colon (:).
Availability Local, full, and lightweight clients.
Syntax progName = Object. ProgrammaticName
Element Description
progName The ProgrammaticName of the object.
Object The network variable to be acted on.
Data Type String.
Read/Write Read-only for static network variables. Read/write for
dynamic network variables. You can check if a network
variable is dynamic or static by reading the IsDynamic
property.
When writing to this property, you should note that some
devices, such as the SmartServer, require that all network
variables within the device have a unique programmatic
name. In addition, all network variables contained within a
custom Interface object must have unique programmatic
names. If you attempt to assign a duplicate programmatic
name to a network variable on such a device, the operation
will fail, and the LCA, #132
lcaErrUniqueNvNameRequired exception will be thrown.
Added to API Prior to LNS Release 3.0.