Echelon OpenLNS User Manual

Page 400

Advertising
background image

OpenLNS Programmer's Reference

363

FormatType property is set to lcaFormatTypeNamed (0).

In that case, the Scope and ProgramId properties are used to

identify the resource file containing the type’s definition.
The way that OpenLNS determines the default value for this

property, and the syntax you can use when writing to this

property, varies depending on the type of object to which the

FormatSpec applies:

NvMonitorPoint object or a DataPoint object that

represents a network variable using a standard type.
The FormatType property will be initially set to

lcaFormatTypeNv (1), and this property will have no

effect. However, you can still set the FormatType

property to lcaFormatTypeNamed (0) and then write

to the FormatName property using the same syntaxes

you would use when setting a NetworkVariable object’s

DsFormatType property.

DataPoint object that represents a network variable

using a user-defined type.
The FormatType property will be initially set to

lcaFormatTypeNamed (0), and the FormatName

property will default to the TypeName assigned to the

DataPoint object. In this case, you can also write to the

FormatName property using the same syntaxes you

would use to write to a NetworkVariable object’s

DsFormatType property. See the DsFormatType property

for more information.

DataPoint object that represents a configuration

property.
The FormatType property will be initially set to

lcaFormatTypeNamed (0), and the FormatName

property will default to the TypeName assigned to the

DataPoint object. You can write to the FormatName

property using the same syntaxes you would use to write

to a ConfigProperty object’s FormatName property.

OpenLNS will determine the default value for the

property in the same manner, as well. Consult the online

help for the FormatName property of the ConfigProperty

object for more information on this.

Note: FormatSpec objects are not passed by reference. If you

modify the values assigned to the properties of a FormatSpec

object, you must then explicitly assign the FormatSpec object

back to the FormatSpec property of the NvMonitorPoint or

DataPoint for the changes to take effect.

Availability

Local, full, lightweight, and independent clients. Note that

some objects containing this property are not available to

Independent clients.

Syntax

formNameValue = fsObject.

FormatName

Advertising