Toindex, Toownerindex – Echelon OpenLNS User Manual

Page 990

Advertising
background image

OpenLNS Programmer's Reference

953

ToIndex

Summary

Returns the device index value assigned to the external

interface component after the upgrade. This is the

component in the external interface file that is represented

by this

UpgradeInfo

object.

If the Class property is set to lcaUgClsConfigProp (4),

lcaUgClsLmObjConfigProp (5) or

lcaUgClsNetVarConfigProp (6), the UpgradeInfo

obect

represents a configuration property.
In this case, the ToIndex property contains the handle

assigned to the configuration property in the external

interface file

in the upgraded external interface file

, and not

the device index. The handle is relative to the object

containing the configuration property.
If the configuration property is contained by a

LonMarkObject or network variable, the FromOwnerIndex

property contains the device index assigned to the owner

LonMarkObject or network variable in the upgraded external

interface.

If the

UpgradeInfo

object's

Status

property is set to

lcaUgStsDeleted (1), then the component represented by

this

UpgradeInfo

object was deleted from the external

interface file during the upgrade. In this case, the

ToIndex

property will be -1.

Availability

Local, full, and lightweight clients.

Syntax

indexValue = uiObject.

ToIndex

Element

Description

indexValue

The device index value assigned to the

external interface component after the

upgrade.

uiObject

The UpgradeInfo object to be acted on.

Data Type

Long.

Read/Write

Read only.

Added to API

LNS Release 3.0.

ToOwnerIndex

Summary

If the

UpgradeInfo

object represents a configuration

property,

this property returns the device index value

assigned to the parent LonMarkObject or network variable in

the external interface file after the upgrade.

If the

UpgradeInfo

object does not represent a configuration

property that is contained within a

LonMarkObject

or

NetworkVariable

, this property will return -1.

If the

UpgradeInfo

object does represent a configuration

Advertising