Echelon OpenLNS - Manual (Page 392)

OpenLNS Programmer's Reference 355
such as the format used to display dates and times, and the
unit of measurement associated with the formatted value.
The default values assigned to the properties of the
FormatLocale object match the settings of the pre-defined
"UserDefaultRegionalSettings" FormatLocale object. This
means that the default will be set based on the user-defined
Windows regional settings on the computer running the
application. For more information on these settings, see the
OpenLNS Programmer’s Guide.
After you have created a FormatLocale object, you should set
its properties to meet your application’s requirements. Then,
you can make it the active FormatLocale object on the system
by writing to the CurrentFormatLocale property of the
ObjectServer object.
Note: You can only write to the CurrentFormatLocale
property or to the FormatLocale object acting as the
CurrentFormatLocale before your application has opened any
networks and 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. If you write to the
CurrentFormatLocale property (or if you write to the
FormatLocale object assigned to the CurrentFormatLocale
property) after performing any of these operations, the LCA,
#122 lcaErrReadOnlyInContext exception will be thrown
Availability Local, full, lightweight, and independent clients. Note that
some collections are not available to Independent clients.
Syntax newFormatLocale = flCollection.Add name
Element Description
newFormatLocale The FormatLocale object returned by
the function. This is the newly
defined FormatLocale object.
flCollection The FormatLocales collection being
acted upon.
name The name of the new FormatLocale
object. This can be a maximum of 85
characters long. The forward slash (/),
back slash (\), period (.), and colon (:)
characters may not be used in the
name.
Added to API LNS Release 3.20.
Remove
Summary Removes a FormatLocale object from the collection.
The indexName element is a Variant type, which allows you
to specify the FormatLocale to be deleted by either its name,
or by the index number assigned to it within the