Count, Filtertype – Echelon OpenLNS User Manual

Page 160

Advertising
background image

OpenLNS Programmer's Reference

123

added to the API.

Comments

This property allows the object type to be determined when it

is unknown (for example, when the object was accessed using

the Parent property of another object).

Count

Summary

Returns the number of objects in a collection. You can use

this property to enumerate a collection object.

Availability

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

some collection objects are not available to Independent

clients.

Syntax

returnValue = object.Count

Element

Description

returnValue

The number of objects in the collection

as a long integer.

object

The collection object to be acted on.

Data Type

Long.

Read/Write

Read only.

Added to API

Depends on the object used to access the property. Generally,

this property exists for an object as soon as the object is

added to the API.

Comments

This property is read only for Error objects.

FilterType

Summary

Enables a subset of the items in the

Channels

collection to be

selected.
The filter property can be set to allow queries on selected

groups of objects in the

Channels

collection. Set the

FilterType

property to the appropriate constant values before

accessing any objects in the collection.
You can

use RefChannel1 and RefChannel2

properties

included in the

Channels

object to help search a

Channels

collection. These variants have meaning in the context of

particular filters.
To use channel filtering, a populated channel object must

first be obtained. For example:

Set AllChannels = Network.Channels
Set FilteredChannels = AllChannels
FilteredChannels.FilterType = lcaChannelFilterAdjacent

'Print list of channels adjacent to channel named "Room1".
'Assume PrintChannels ’function has been defined.

Set FilteredChannels.RefChannel1 = AllChannels.Item("Room1")
PrintChannels FilteredChannels

Availability

Local, full, and lightweight clients.

Advertising