Remove – Echelon OpenLNS User Manual

Page 497

Advertising
background image

OpenLNS Programmer's Reference

460

devices is described in the OpenLNS Programmer’s Guide.
The name of the new message tag (as specified with the name

element) must be unique on the

Interface

object containing

the

MessageTags

collection. If you attempt to add a message

tag to a message tag collection on a static interface or a

custom interface that does not support dynamic message

tags, the LCA, #119 lcaErrInterfaceNotModifyable

exception will be thrown. The

Interface

objects contained

within a device’s Interfaces property are the device’s custom

interfaces, and the

Interface

object contained within the

device’s

Interface

property is the device’s main, static

interface.
The newly created message tags will be stored in the

MessageTags

collection accessed through the

DynamicMessageTags

property of the

Interface

object

involved. The static message tags contained by the

Interface

are stored in its

MessageTags

property. Note that you can

only call this method on the collection accessed through the

DynamicMessageTags

property. In addition, each device

supports a total of 65,533 dynamic message tags.

Availability

Local, full, and lightweight clients.

Syntax

tag = messageTags.Add name

Element

Description

messageTags

The

MessageTags

collection object being

acted upon.

name

A String representing the name of the

new message tag.
The name can be a maximum of 85

characters long, and it cannot include

the forward slash (/), back slash (\),

period (.), and colon (:) characters.

tag

The

MessageTag

object returned by the

method. This is the newly defined

message tag.

Added to API

LNS Release 3.20.

Remove

Summary

Removes an object from the specified 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 collection containing the object to

be removed.

Advertising