Count, Item – Echelon OpenLNS User Manual

Page 175

Advertising
background image

OpenLNS Programmer's Reference

138

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 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.

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 object retrieved from the collection.

collObject

The collection object to be acted on.

index

A Long type specifying the ordinal

index of the object to retrieve.

stringExpression A string type specifying the name of the

object to retrieve.

Advertising