Altformatname, Altformatnamescount – Echelon OpenLNS User Manual

Page 398

Advertising
background image

OpenLNS Programmer's Reference

361

ClassId

FormatName

FormatType

Index

Parent

Precision

ProgramId

Scope

Units

UnitsAdder

UnitsMultiplier

AltFormatName

Summary

Contains an indexed list of all formats that can be applied to

this data type.
This allows you to search for other FormatSpec objects that

contain alternate formats. For example, in a FormatSpec

object representing the SNVT_temp_f#US format (for

example, degrees Fahrenheit), this property would contain

"SNVT_temp_f#US ", "SNVT_temp_f#SI", and

"SNVT_temp_f#US_diff".
The AltFormatNamesCount property indicates how many

alternate formats are available.

Availability

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

some objects containing this property are not available to

Independent clients.

Syntax

altName= fsObject.

AltFormatName

index

Element

Description

altName

The alternate format.

fsObject

The

FormatSpec

object to be acted on.

index

If multiple formats for this type exist,

the index number of the format to be

returned. The index number must be

between 1 to x, where x represents the

number of alternate formats available.

Data Type

String.

Read/Write

Read only.

Added to API

LNS Release 3.0.

AltFormatNamesCount

Summary

Indicates how many alternate formats are contained in the

AltFormatName

property

.

Availability

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

some objects containing this property are not available to

Independent clients.

Advertising