Properties – Echelon OpenLNS User Manual

Page 393

Advertising
background image

OpenLNS Programmer's Reference

356

FormatLocales collection. You can determine the name of a

FormatLocale object by reading its Name property.
Note that the FormatLocales collection contains 4 pre-defined

FormatLocale objects, using indices 1–4, that cannot be

deleted. If you attempt to delete these FormatLocale objects

with this method, the LCA, #122

lcaErrReadOnlyInContext exception will be thrown.
If you delete the FormatLocale object acting as the

CurrentFormatLocale, your application will use the

UserDefaultRegionalSettings FormatLocale object (index

1) until you write a new value to the CurrentFormatLocale

property.
You can only use this method to delete the FormatLocale

object acting as the CurrentFormatLocale (and you can only

write to the CurentFormatLocale property) before your

application has opened any networks or formatted any data.

Operations that will cause your application to format data

include acquiring a DataPoint object, and reading or writing

the value of a ConfigProperty or NetworkVariable object.

Availability

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

some collections are not available to Independent clients.

Syntax

flCollection.Remove indexName

Element

Description

flCollection

The FormatLocales collection being

acted upon.

indexName

A Long value specifying the collection

index of the FormatLocale object to

remove, or a String value specifying the

name of the FormatLocale object to

remove.

Added to API

Prior to LNS Release 3.0.

Properties

The FormatLocales

object contains the following properties

:

ClassId

Count

Item

Parent

_NewEnum

Advertising