beautypg.com

Item – Echelon OpenLNS User Manual

Page 161

background image

OpenLNS Programmer's Reference

124

Syntax

filterValue = channelsCollection.FilterType

Element

Description

filterValue

The active filter type. The valid values

for this property, which are contained

in the

ConstChannelFilterTypes

constant, are as follows:
0 lcaChannelFilterNone
All objects in the collection are shown.
1 lcaChannelFilterAdjacent
Only channels adjacent to

RefChannel1

(as Channel object) are

shown.
2 lcaChannelFilterPath
Only channels connecting

RefChannel1

(as Channel object) and

RefChannel2

(as Channel object) are

shown.
3 lcaChannelFilterTransceiver
Only channels which have the

transceiver ID specified in

RefTransceiverType

(as integer) are

shown.

channelsCollection The Channels collection object.

Data Type

Integer.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

Item

Summary

Returns an object from a collection. You can retrieve an

object from its collection by passing its index (ordinal

position) within that collection as the argument for the Item

property. Index values start at 1. You can also retrieve an

object in collections that contain objects with the Name

property by passing the object’s name as a string expression

Availability

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

some objects containing this property are not available to

Independent clients.

Syntax

retrievedObject = collObject.Item(index)

retrievedObject = collObject.Item(stringExpression)

Element

Description

retrievedObject

The

Channel

object retrieved from the

collection.