Configfileoffset, Constantattribute – Echelon OpenLNS User Manual

Page 191

Advertising
background image

OpenLNS Programmer's Reference

154

added to the API.

Comments

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).

ConfigFileOffset

Summary

Specifies the byte offset into the configuration value file that

implements the ConfigProperty

object.

A ConfigProperty

object is implemented by a configuration

network variable or a configuration value file. To determine

how the configuration property is implemented, read the

ImplementationType property of the ConfigProperty

object.

If the configuration property is implemented by a

configuration value file, this property identifies the byte

offset into the configuration value file. To determine the

value file to which this offset applies, read the

ConfigFileType property

.

If the configuration property is an array implemented by

a configuration value file, elements will occupy

consecutive spaces in the file. This property returns the

byte offset into the configuration value file of the first

element. To determine the byte offset for subsequent

elements, simply add the appropriate multiple of the

element’s length to this offset. To determine the length

of the array’s elements, see the ByteLength property.

If the configuration property is implemented by a

configuration network variable, this property throws an

LCA, #165

exception ( “configuration property not

implemented by a configuration value file”).

Note: This property is not currently available from within a

DeviceTemplate object; therefore, it will throw a

LCA, #38

LCA_APP_DEVICE_REQUIRED

exception when accessed.

Availability

Local, full, and lightweight clients.

Syntax

fileOffset = cpObject.ConfigFileOffset

Element

Description

fileOffset

The byte offset into the configuration

value file implementing this

configuration property.
To determine the value file to which

this offset applies, read the

ConfigFileType property of the

ConfigProperty

object.

cpObject

The file-based

ConfigProperty

object

to be acted on.

Data Type

Long.

Advertising