Formattype, S formattype p, Formattype p – Echelon OpenLNS User Manual

Page 401: E formattype

Advertising
background image

OpenLNS Programmer's Reference

364

Element

Description

fsObject

The

FormatSpec

object to be acted on.

formNameValue

The FormatName as a string.

Data Type

String.

Read/Write

Read/write.

Added to API

LNS Release 3.0.

FormatType

Summary

Determines the base type of the data read from and written

to

FormattedValue

property in the

DataPoint

or

NvMonitorPoint

object using the

FormatSpec

object

.

Availability

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

some objects containing this property are not available to

Independent clients.

Syntax

formatType = fsObject.

FormatType

Element

Description

formatType

The type for the data.

Typically, OpenLNS will automatically

assign each data point a type based on

the type of the network variable or

configuration property associated with

the data point. You can use this

property to override that setting. Also,

you can set options to use when

displaying the formatted value of data

point objects by writing to the

CurrentFormatLocale being used by

your application.
The enumerated values for this

element, which are contained in the

ConstLNSFormatType constant, are as

follows:
0 lcaFormatTypeNamed
The FormatSpec object contains a

format for a user defined network

variable or configuration property type.
If the type is a user-defined network

variable or configuration property type

(UNVT or UCPT), set this property to

lcaFormatTypeNamed(0), set the

FormatName property to the name of

the user type, and set the Scope and

ProgramId properties to the scope and

Program ID of the format file

containing the definition of the type.

Advertising