Addcompatiblenvex – Echelon OpenLNS User Manual

Page 411

Advertising
background image

OpenLNS Programmer's Reference

374

the ProgrammaticName property.

sourceNvObj

The

NetworkVariable

object which the

new network variable is based upon.

Added to API

Prior to LNS Release 3.0.

AddCompatibleNvEx

Summary

Creates a

NetworkVariable

object that is compatible with a

specified source network variable and adds the new network

variable to the specified

Interface

object.

This method differs from

AddCompatibleNv

method in that

this method allows you to set options

.

Availability

Local, full, and lightweight clients.

Syntax

nvObject = interfaceObject.AddCompatibleNvEx(nvName,

sourceNvObj, flags)

Element

Description

nvObject

The compatible network variable to be

returned.

A compatible network variable is one

that is of the same type and direction

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 which

the new network variable is based

upon.

flags

The options which will apply to the

newly created network variable.
The possible values for the flags

parameter, which are contained in the

Advertising