Description, Extensions – Echelon OpenLNS User Manual

Page 341

Advertising
background image

OpenLNS Programmer's Reference

304

extension

The

Extension

object to be acted upon.

Data Type

Boolean.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

Description

Summary

Stores description information about the

Extension

object

.

Availability

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

some collections are not available to Independent clients.

Syntax

stringValue = object.Description

Element

Description

stringValue

A string description of the

Extension

object.

object

The

Extension

object to be acted on.

Data Type

String.

Read/Write

Read/write.

Added to API

This depends on the object used to access the property.

Generally, this property exists for the objects listed above as

soon as they are added to the API. See the applicable object

to determine what release it was introduced in.

Extensions

The Extensions property can be used to retrieve a child Extensions collection from a

parent Extension object. This property supports the concept of hierarchical Extension

objects.
An Extension object cannot be removed from its parent object if the Extension has any

child Extension objects. All child Extension objects must be removed first. An attempt to

remove a non-empty Extension object will result in an

lcaErrCantRemoveExtensionWithChildren (LCA #173) exception being thrown.

Summary

Retrieves a child Extensions collection from a parent

Extension object

.

Availability

Local, full, and lightweight clients.

Syntax

extensions = extension.Extensions()

Element

Description

extension

The parent

Extension

object.

object

The child

Extensions

collection.

Data Type

Object.

Read/Write

Read only.

Added to API

OpenLNS.

Advertising