Addcomplementarynvex – Echelon OpenLNS User Manual

Page 413

Advertising
background image

OpenLNS Programmer's Reference

376

as the source network variable. This

method is used to construct an

interface object for a host application.

interfaceObject

The

Interface

object to be acted on.

nvName

A String containing the name of the

added network variable.

The name specified in this parameter

can be a maximum of 16 characters,

and it must not start with a number.

In addition, it cannot include square

brackets ([]), commas (,), or periods (.).
Once the NetworkVariable object has

been created, it may be renamed

subject to the restrictions of the Name

property.
The name specified in this method

may subsequently be retrieved using

the ProgrammaticName property.

sourceNvObj

The

NetworkVariable

object for which

a complementary network variable is

created.

Added to API

Prior to LNS Release 3.0.

AddComplementaryNvEx

Summary

Creates a

NetworkVariable

object that is complementary to a

specified target network variable, and adds the

complementary network variable to the specified

Interface

object

.

This method differs from

AddComplementaryNv method

in that it allows you to set options

.

A network variable is complementary to another network

variable if it uses the same type and configuration (for

example, service type, authentication setting, default value,

polling attribute) but opposite direction (two network

variables that may be bound together). This method is used

to construct an

Interface

object for a host application. This

method is typically used to create an input network variable

that is subsequently bound to a target output network

variable that is to be monitored

This method should only be called on a custom Interface

object that is contained by a device that supports dynamic

network variables.

Availability

Local, full, and lightweight clients.

Syntax

nvObject =

interfaceObject.AddComplementaryNv(nvName,

sourceNvObj)

Advertising