Methods, Remove – Echelon OpenLNS User Manual
Page 862
OpenLNS Programmer's Reference
825
Methods
The Subnets object contains the following methods
.
•
•
Add
Summary
Defines a new Subnet object.
Subnets are typically added automatically when routers or
devices are added. In most cases there is no reason for your
application to manually allocate subnets. Subnets can be
explicitly added using this method. You can then force a
given set of devices onto the same subnet with the MoveEx
method take advantage of subnet broadcast messaging.
Availability
Local, full, and lightweight clients.
Syntax
subnetObject = subnetsColl.Add(subnetName, subnetId)
Element
Description
subnetObject
The newly defined subnet object.
subnetsColl
The Subnets collection object.
subnetName
A String containing the name of
the subnet.
subnetId
An Integer value indicating the
subnet ID.
This element may be a value from
0–255.
A value of 0 indicates that the
Object Server should assign the
subnet ID.
Added to API
Prior to LNS Release 3.0.
Remove
Summary
Removes a subnet from the system.
A subnet may only be
removed if there are no devices assigned to it.
Availability
Local, full, and lightweight clients.
Syntax
subnetsColl.Remove indexName
Element
Description
subnetsColl
the subnet to be removed.
indexName
A Long value specifying the collection
removed, or a String value specifying
removed.