Name – Echelon OpenLNS User Manual

Page 511

Advertising
background image

OpenLNS Programmer's Reference

474

The MsgMonitorOptions object contained within this

property is not passed by reference. If you acquire a

MsgMonitorOptions object through the MsgOptions property

and modify it, you must then explicitly assign the modified

MsgMonitorOptions object back to the MsgOptions property

for the changes to take effect. This following code sample

demonstrates this procedure:

Set msgOptions = monSet.MsgOptions

msgOptions.Name = "Device 003"

Set monSet.MsgOptions = msgOptions

You should note that each MsgMonitorPoint object in a

monitor set contains a CurrentOptions property and a

CurrentOptions property. Once the monitor set containing a

MsgMonitorPoint has been opened, you can use the monitor

point’s CurrentOptions property to set the monitoring options

that will be used for the MsgMonitorPoint during that

particular session.
You can use a permanent message monitor point’s

DefaultOptions property to change the default monitoring

options that will be applied to that particular message

monitor point in future monitoring sessions. This may be

useful if you want a message monitor point in a permanent

monitor set to use a different set of default monitoring

options than those defined for the entire monitor set. The

DefaultOptions properties of message monitor points in

temporary monitor sets are not accessible because temporary

monitor sets are only used in a single client session.

Availability

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

temporary

MonitorSet

objects are not available on

Independent clients.

Syntax

msgOptions = monSetObject.MsgOptions

Element

Description

msgMonSetColl

The

MsgMonitorPoints

collection

object returned.

monSetObject

The

MonitorSet

object to be acted

on.

Data Type

MsgMonitorOptions

object.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

Name

Summary

Specifies the name of an object as a character string. This

property is case sensitive. Searches by name must match

case.
This property can be a maximum of 85 characters long, but it

may not contain the forward slash (/), back slash (\), period

Advertising