Formatspec – Echelon OpenLNS User Manual

Page 277

Advertising
background image

OpenLNS Programmer's Reference

240

FormatSpec

Summary

Contains the format specification information for data read

from the

FormattedValue

property in the

DataPoint

object.

This property contains a FormatSpec object that determines

the base type to use when reading the formatted values of the

data point or monitor point. For data points acquired through

NetworkVariable objects, the default settings for the

FormatSpec object are determined based on the network

variable’s TypeSpec property.
You can also use the CurrentFormatLocale property to

determine what options OpenLNS will use when displaying

the data stored in the FormattedValue property.
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

FormatSpec property of the DataPoint for the changes to take

effect. This following code sample demonstrates this

procedure:

Set fsObject = dpObject.FormatSpec
fsObject.FormatName = "SNVT_temp_f#SI"
Set dpObject.FormatSpec = fsObject

Availability

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

some collection objects are not available to Independent

clients.

Syntax

fsObject= dpObject.FormatSpec

Element

Description

fsObject

The

FormatSpec

object containing the

format information.

dpObject

The

DataPoint

object to be acted on.

Data Type

FormatSpec object

.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

Advertising