Removeex – Echelon OpenLNS User Manual
Page 836
OpenLNS Programmer's Reference
799
the router to be removed.
indexName
A Long value specifying the collection
object to remove, or
a String value specifying the name of
object to remove.
Added to API
Prior to LNS Release 3.0.
RemoveEx
Summary
This method is identical to the Remove method of the Routers
collection, but it allows you to set additional options when
removing a router from the collection.
Availability
Local, full, and lightweight clients.
Syntax
routersColl.RemoveEx index, flags
Element
Description
routersColl
The Routers collection object.
index
A Long value specifying the collection index
of the router to remove.
flags
A Long value specifying the removal
options for this router.
The possible values of this element, which
are defined in the ConstRouterFlags
constant, are as follows:
0 lcaRouterFlagNoMerge
The router should be removed normally.
1 lcaRouterFlagMerge
Allows a router to be removed even though
the far side channel has nodes attached. If
this option is specified, the near side
channel will be removed. All devices on the
near side channel will be moved to the far
side channel. The application is responsible
for applying the appropriate label to the
resulting channel.
You can apply this option to any two
routers, even if they do not use the same
transceiver type. However, devices using
the remaining channel after the merge will
be unable to communicate due to the
incompatibility between the two routers. As
a result, before merging two routers with
this option, you should make sure the
routers use the same transceiver type.
This option only applies if the network
management mode property is set to
lcaMgmtModePropagateConfigUpdate