Removebyindex, Properties – Echelon OpenLNS User Manual

Page 662

Advertising
background image

OpenLNS Programmer's Reference

625

networkVariables

The

NetworkVariables

collection to be

acted upon.

indexName

A Long value specifying the collection

index of the

NetworkVariable

object

to remove, or a String value

specifying the name of the

NetworkVariable

object to remove.

Added to API

LNS Release 3.20.

RemoveByIndex

Summary

Removes a

NetworkVariable

from the collection. You can

specify the network variable to be deleted by its index

number within the collection.

You can use this method to remove network variables from

collections that are contained by dynamic LonMarkObject

objects, or by custom Interface objects.
You can determine the device index number assigned to a

network variable by reading its Index property.
If the network variable being removed is a member of a

LonMarkObject, it will be unassigned from the

LonMarkObject as it is removed from the collection. You can

assign network variables to LonMarkObject objects using the

AssignNetworkVariable method.
If the network variable is part of a connection, it will not be

deleted, and the NS, #164 lcaErrNsNvmtInUse exception

will be thrown.

Availability

Local, full, and lightweight clients.

Syntax

networkVariables.RemoveByIndex deviceIndex

Element

Description

networkVariables

The

NetworkVariables

collection to

be acted upon.

deviceIndex

The device index number assigned

to the network variable being

removed.

Added to API

LNS Release 3.20.

Properties

The NetworkVariables

object contains the following properties

:

ClassId

Count

Item

Parent

_NewEnum

Advertising