Length – Echelon OpenLNS User Manual

Page 976

Advertising
background image

OpenLNS Programmer's Reference

939

TRUE. The TypeSpec

object is complete.

FALSE. The TypeSpec object is incomplete. Several

conditions may cause a TypeSpec object to be incomplete.

For example, if you try to get a TypeSpec object for a

network variable with a changeable UNVT type that uses

a configuration property, and the category of the

configuration property is either CAT_INITIAL or

CAT_NULL, then the TypeSpec object would be

incomplete.

Availability

Local, full, and lightweight clients.

Syntax

complete = typeSpec.

IsComplete

Element

Description

complete

A Boolean value indicating whether the

TypeSpec

object is complete.

typeSpec

The

TypeSpec

object to be acted on.

Data Type

Boolean.

Read/Write

Read only

Added to API

LNS Release 3.20.

Length

Summary

Indicates the length (in bytes) of network variables that use

the type referenced by this

TypeSpec

object.

When new values are written to the Scope, ProgramID,

TypeName properties of the TypeSpec object and the

TypeSpec object is passed back to the network variable,

OpenLNS sets the Length property automatically.

When you assign the

TypeSpec

object to a network variable,

make sure that the value of this property does not exceed the

value assigned to the network variable’s

MaxLength

property. Otherwise, the LCA#156

lcaErrTypeLengthTooLong exception will be thrown.

Availability

Local, full, and lightweight clients.

Syntax

lengthInBytes = typeSpec.

Length

Element

Description

lengthInBytes

The length of network variables (in

bytes) using the type referenced by this

TypeSpec

object.

typeSpec

The

TypeSpec

object to be acted on.

Data Type

Long.

Read/Write

Read only.

Added to API

LNS Release 3.20.

Advertising