Typespec, Networkvariables, Typespec p – Echelon OpenLNS User Manual

Page 655

Advertising
background image

OpenLNS Programmer's Reference

618

TypeSpec

Summary

Contains an object that defines the type used by the network

variable.

This includes the name of the network variable

type, and the scope and program ID of the resource file that

contains the definition of the type. OpenLNS uses this

information to identify the type a network variable should

use.

In some cases, you can write to the properties of this

object to change the network variable’s type

.

If the ChangeableTypeSupport property of the network

variable is set to lcaNvChangeableTypeSdOnly (1) or

lcaNvChangeableTypeSCPT (2), you can modify the

network variable’s type by writing new values to the

properties of the TypeSpec object. For more information on

this, see the TypeSpec object.
If the ChangeableTypeSupport property is set to

lcaNvChangeableTypeNone (0), then you cannot modify

the network variable’s type. If you attempt to write to this

property, the LCA#:157 lcaErrTypeNotChangeable

exception will be thrown.
The TypeSpec object contained within this property is not

passed by reference. If you modify the values assigned to the

properties of a local TypeSpec object, you must then explicitly

assign the modified TypeSpec object back to the TypeSpec

property of the NetworkVariable for the changes to take

effect. See the TypeSpec object for more information.

Availability

Local, full, and lightweight clients.

Syntax

typeSpecObject = networkVariable.TypeSpec

Element

Description

typeSpecObject

The

TypeSpec

object returned by the

property.

networkVariable

The

NetworkVariable

object to be

acted upon.

Data Type

TypeSpec

object.

Read/Write

Read/write.

Added to API

LNS Release 3.20.

NetworkVariables

A NetworkVariables object is a collection of NetworkVariable objects. You can use the Item

property, the ItemByProgrammaticName method, or the ItemByIndex method to retrieve a

network variable from the collection. The following table summarizes the NetworkVariables

object.

Description

A collection of

NetworkVariable

objects.

Added to API

Prior to LNS Release 3.0.

Advertising