Inputformatspec, Name – Echelon OpenLNS User Manual

Page 537

Advertising
background image

OpenLNS Programmer's Reference

500

InputFormatSpec

Summary

Contains the

FormatSpec

object used to determine the format

for incoming messages for this

MsgMonitorPoint

object

.

The FormatSpec object contained within this property is not

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

properties of a local FormatSpec object, you must then

explicitly assign the modified FormatSpec object back to the

InputFormatSpec property of the MsgMonitorPoint for the

changes to take effect. This following code sample

demonstrates this procedure:
Set fsObject =
msgMonitorPointObject.InputFormatSpec

fsObject.AltFormatName = "SNVT_temp_f#SI"

Set msgMonitorPointObject.InputFormatSpec =
fsObject

Availability

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

temporary

MonitorSet

objects and temporary monitor points

are not available on Independent clients.

Syntax

fsObject = msgMpObject.InputFormatSpec

Element

Description

fsObject

The

FormatSpec

object used to interpret

incoming messages.

msgMpObject

The

MsgMonitorPoint

object to be acted

on.

Data Type

FormatSpec

.

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

(.), and colon (:) characters.

Availability

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

some objects that contain this property are not available to

Independent clients.

Syntax

stringValue = object.Name

Element

Description

stringValue

The name of the object.

object

The object to be acted on.

Advertising