Echelon OpenLNS - Manual (Page 835)

OpenLNS Programmer's Reference 798
Routers collection.
coll The Routers collection object.
handle A Long value specifying the handle of
the Router object to be retrieved.
Added to API LNS Release 3.0.
ItemByNeuronID
Summary Retrieves a Router object, specified by its NeuronID property,
from a Routers collection.
Availability Local, full, and lightweight clients.
Syntax object = coll.ItemByNeuronId(neuronId)
Element Description
object The Router retrieved from the
collection.
coll The Routers collection object.
neuronId A String specifying the Neuron ID of
the Router object to be retrieved.
Added to API LNS Release 3.0.
Remove
Summary Removes a router from a subsystem. If the router is not a
member of any other subsystems, then it is removed from the
system and the network.
A router is removed from a subsystem by removing the
corresponding Router object from the Routers collection object
owned by that Subsystem object. If the router is in any other
subsystems, then nothing further is done.
If the router in not a member of any other subsystem, then
the router is completely removed from the system. The
router is removed from all connections, removed from the
system domain, and placed in the unconfigured state; the
router’s channel ID is set to 0. No other changes are made in
the router’s network image. The NSS Handle is also freed
and is available for use by the Object Server.
A Router object can only be removed from a "regular"
subsystem. The Routers collection object’s Remove method
cannot be used on the All, Discovered.Installed, or
Discovered.Uninstalled subsystems.
Availability Local, full, and lightweight clients.
Syntax RoutersColl.Remove indexName
Element Description
RoutersColl The Router collection object containing