Echelon OpenLNS User Manual

Page 202

Advertising
background image

OpenLNS Programmer's Reference

165

that has the same name as the underlying type. This is

called the root format for the type, and may be different

from the default format for that type. In order to

explicitly use this root format, you will need to append

the ‘#’ character to the format name to indicate that you

are specifying the format name (and not the type name)

for this type. For example, if you read the value of a

configuration property of type SCPTminSndT when the

CategoryPreferenceList property of the FormatLocale

object your application is using is set to LO, and you set

the FormatName property to SCPTminSndT, the data

stored in the Value property will be formatted using the

SCPTminSndT#LO format. However, if you set the

FormatName property to SCPTminSndT#, the Value

property will be formatted using the root SCPTminSndT

format.

3. A fully-qualified format name, expressed in the following

syntax: "#<progID>[<scope>].<format name>"
In this syntax, the "#", "[", "]" and "." characters are

literal characters. A hex byte string represents the

program ID. The scope is a one-digit string. It represents

a filter that indicates relevant parts of the program ID,

and may be one of the following:
0 - Standard
1 - Device Class
2 - Device Class and Usage
3 - Manufacturer
4 - Manufacturer and Device Class
5 - Manufacturer, Device Class, and Device Subclass
6 - Manufacturer, Device Class, Device Subclass, and

Device Model
For example, #800001128000000[4].UNVT_date_event

4. The name of one of the Data Server built-in types, which

include "INT", "REAL", "DISCRETE", "BINARY", "RAW"

and "RAW_HEX".

Note: Use of the old syntax of <file name>.<type name>

for FormatName is no longer supported. This notation was

used for pre-L

ON

M

ARK

resource files.

Availability

Local, full, and lightweight clients.

Syntax

formNameValue = cpObject.

FormatName

Element

Description

cpObject

The

ConfigProperty

object to be acted

on.

formNameValue

The

FormatName

as a string.

Advertising