Bytelength, Classid – Echelon OpenLNS User Manual

Page 190

Advertising
background image

OpenLNS Programmer's Reference

153

ByteLength

Summary

Returns the length (in bytes) of a single configuration

property element.
Multiplying this length by the number returned by the

Dimension

property gives you the total length (in bytes) of

this configuration property. If this configuration property is

not an array, the

Dimension

property returns 1, and the

ByteLength

property returns the full length of the

configuration property.
Note: If a configuration property inherits its type from a

network variable that supports changeable types, and the

type of that network variable is changed, this property will

not be updated to reflect the change. You can check if the

configuration property inherits its type by reading the

TypeInherits

property.

Availability

Local, full, and lightweight clients.

Syntax

length = cpObject.ByteLength

Element

Description

cpObject

The

ConfigProperty

object to be acted on

length

The byte length of this

ConfigProperty

object

Data Type

Integer.

Read/Write

Read only.

Added to API

Prior to LNS Release 3.0.

ClassId

Summary

Identifies the object class of this 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

ConfigProperty

object in the

ConstClassIds

constant:

26 lcaClassIdConfigProp

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

Advertising