Itembyhandle, Itembyprogramid, Remove – Echelon OpenLNS User Manual

Page 325

Advertising
background image

OpenLNS Programmer's Reference

288

This value is not supported.

Added to API

Prior to LNS Release 3.0.

ItemByHandle

Summary

Retrieves a DeviceTemplate object by its handle property

from the DeviceTemplates collection. This may be

particularly useful when processing events reported by

OnChangeEvent with the objectType of

lcaChangeEventDeviceTemplates.

Availability

Local, full, and lightweight clients.

Syntax

deviceTemplate = deviceTemplates.ItemByHandle

Element

Description

deviceTemplate The DeviceTemplate object.
deviceTemplates

The DeviceTemplates collection.

handle

The handle of the DeviceTemplate to be

retrieved.

Added to API

OpenLNS.

ItemByProgramID

Summary

Retrieves a

DeviceTemplate

object, specified by its

ProgramID

property, from a

DeviceTemplates

collection.

Availability

Local, full, and lightweight clients.

Syntax

dtObject = dtColl.ItemByProgramId(programId)

Element

Description

dtObject

The

DeviceTemplate

object retrieved

from the collection.

dtColl

The

DeviceTemplates

collection object.

programId

A String specifying the program ID of

the

DeviceTemplate

object to be

retrieved.

Added to API

Prior to LNS Release 3.0.

Remove

Summary

Removes an object from the specified collection.

Availability

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

some collections are not available to Independent clients.

Syntax

objectColl.Remove indexName

Element

Description

objectColl

The collection containing the object to

be removed.

Advertising