Item – Echelon OpenLNS User Manual

Page 499

Advertising
background image

OpenLNS Programmer's Reference

462

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

A MessageTags object is a collection of

MessageTag

objects.

You can retrieve a

MessageTag

object from its MessageTags

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

MessageTag

object

in MessageTags collections with the Name property by

passing the

MessageTag

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

MessageTag

object retrieved from

the collection.

collObject

The MessageTags collection object to be

acted on.

index

A Long type specifying the ordinal

index of the

MessageTag

object to be

retrieved.

stringExpression A string type specifying the name of the

MessageTag

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.

Advertising