Selfdocumentation, Usertypefilename – Echelon OpenLNS User Manual

Page 322

Advertising
background image

OpenLNS Programmer's Reference

285

value that conflicts with the

configurations of the devices using a

template. If you set this property to a

setting that violates the configuration

of devices already using the template,

then the NS, #59

lcaErrNsProgramIntfMismatch

exception is thrown.

devTemplateObject

The

DeviceTemplate

object to be acted

upon.

Data Type

Integer.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

SelfDocumentation

Summary

Stores the self-documentation string of the application device.
The length of the string is not provided as a separate property. To

get the length, get the descriptionString, and calculate the length

from it. Note that this property returns only the user portion

(which follows the LonMark portion, if any) of the

self-documentation string

Availability

Local, full, and lightweight clients.

Syntax

descriptionString = object.SelfDocumentation

Element

Description

programIdValue

The program ID value of the object.

object

The object to be acted on.

Data Type

String.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

UserTypeFileName

Summary

Contains an alternative base file name for user formatting.
Setting this property to "<my fomat file>" causes the Object

Server to automatically prepend "<my format file>." when

assigning the network variable's type. Otherwise, it will

defer to the default Data Server behavior.

Availability

Local, full, and lightweight clients.

Syntax

formatString = devTemplateObject.UserTypeFileName

Element

Description

formatString

The user type format file path.

If you specify this element, the

string value will be used as the

Advertising