Itembyhandle, Itembyneuronid, Remove – Echelon OpenLNS User Manual

Page 133

Advertising
background image

OpenLNS Programmer's Reference

96

Element

Description

collection

The

AppDevices

collection to gain the

reference.

object

The

AppDevice

object to be added.

Added to API

Prior to LNS Release 3.0.

ItemByHandle

Summary

Retrieves an

AppDevice

object, specified by its handle, from

an

AppDevices

collection. The

AppDevice

object to be

retrieved must be specified by its handle.

Availability

Local, full, and lightweight clients.

Syntax

object = coll.ItemByHandle(handle)

Element

Description

object

The object retrieved from the collection.

coll

The collection object.

handle

A Long value specifying the handle of

the object to retrieve.

Added to API

LNS Release 3.0.

ItemByNeuronID

Summary

Retrieves an

AppDevice

object, specified by its

NeuronId

property, from an

AppDevices

collection.

Availability

Local, full, and lightweight clients.

Syntax

object = coll.ItemByNeuronId(neuronId)

Element

Description

object

The

AppDevice

retrieved from the

collection.

coll

The

AppDevices

collection object.

neuronId

A String specifying the Neuron ID of

the

AppDevice

object to be retrieved.

Added to API

LNS Release 3.0.

Remove

Summary

Removes an application device from a subsystem. If the

application device is not a member of any other subsystems,

then it is removed from the system and the network.

An application device is removed from a subsystem by

removing the corresponding AppDevice object from the

AppDevices collection object owned by that Subsystem object.

If the application device is in any other subsystems, then

nothing further is done.

Advertising