Item, Parent – Echelon OpenLNS User Manual

Page 327

Advertising
background image

OpenLNS Programmer's Reference

290

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 a

DeviceTemplate

object from the

DeviceTemplates

collection. You can retrieve a

DeviceTemplate

object from its

DeviceTemplates

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 a

DeviceTemplate

object in a

DeviceTemplates

collections 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

DeviceTemplate

object retrieved

from the collection.

collObject

The

DeviceTemplates

collection object to

be acted on.

index

A Long type specifying the ordinal

index of the object to be retrieved.

stringExpression

A string type specifying the name of the

object to be retrieved.

Data Type

Object.

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.

Parent

Summary

Returns the object that spawned the current child object. The

parent object is determined by the means in which a child

object is accessed, not by the OpenLNS Object hierarchy.

Advertising