Remove, Removebyindex – Echelon OpenLNS User Manual

Page 482

Advertising
background image

OpenLNS Programmer's Reference

445

Syntax

retrievedObject = collection.

ItemByProgrammaticName

progName

Element

Description

retrievedObject The

LonMarkObject

to be retrieved

from the collection.

collection

The

LonMarkObjects

collection being

acted upon.

progName

The programmatic name of the

LonMarkObject

to be retrieved.

Data Type

LonMarkObject

object.

Added to API

LNS Release 3.20.

Remove

Summary

Removes a

LonMarkObject o

bject from the specified

LonMarkObjects

collection.

Availability

Local, full, lightweight, and independent clients. Note that

some collections are not available to Independent clients.

Syntax

objectColl.Remove indexName

Element

Description

objectColl

The

LonMarkObjects

collection

containing the object to be removed.

name

A Long value specifying the collection

index of the

LonMarkObject

object to be

removed, or a String value specifying

the name of the

LonMarkObject

object

to be removed.

Added to API

Prior to LNS Release 3.0.

RemoveByIndex

Summary

Removes a dynamic

LonMarkObject

(functional block) from the

custom interface containing this collection. You can specify the

LonMarkObject

to be deleted by its device index number.

You can determine the device index of a

LonMarkObject

by

reading its

Index

property.

Note: You cannot remove

LonMarkObjects

from a device’s main

interface. The main interface of a device is stored in its

Interface

property.

Availability

Local, full, and lightweight clients.

Syntax

LonMarkObjects.RemoveByIndex deviceIndex, removalFlags

Element

Description

LonMarkObjects

The

LonMarkObjects

collection to be

Advertising