Classid, Formatname – Echelon OpenLNS User Manual

Page 399

Advertising
background image

OpenLNS Programmer's Reference

362

Syntax

altNameCount = fsObject.

AltFormatNamesCount

Element

Description

altNameCount

The number of alternate formats

contained in the

AltFormatName

property.

fsObject

The

FormatSpec

object to be acted on.

Data Type

Long.

Read/Write

Read only.

Added to API

LNS Release 3.0.

ClassId

Summary

Identifies the object class of this object.
This property allows the object type to be determined when it

is unknown (for example, when the object was accessed using

the Parent property of another object).

Availability

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

some objects containing this property are not available to

Independent clients.

Syntax

classIdValue = object.ClassId

Element

Description

classIdValue

The object class of the object. The

following value is defined for the

FormatSpec

object in the

ConstClassIds

constant:
73 lcaClassIdFormatSpec

object

The object to be acted on.

Data Type

Integer.

Read/Write

Read only.

Added to API

Depends on the object used to access the property. Generally,

this property exists for an object as soon as the object is

added to the API.

FormatName

Summary

Sets the name of the type to use when displaying the

FormattedValue property of the DataPoint

or

NvMonitorPointDataPoint object using this FormatSpec.
If the FormatSpec object’s FormatType property is set to

lcaFormatTypeNv (1), OpenLNS will use the Index

property to determine the type associated with the

FormatSpec object. In this case, the FormatName property

has no effect.
The FormatName property will only be used if the

Advertising