Echelon OpenLNS - Manual (Page 390)

OpenLNS Programmer's Reference 353
based on the system default Windows
regional settings of the computer
running your application.
The default settings may vary
depending on which operating system
is installed on the computer running
the application.
Consult the Microsoft Developer’s
Network documentation for more
information on this.
2 lcaFormatLocaleSource
ManualSetting
This value indicates that the value of
the associated property has been set
manually by your application.
Data Type Long.
Read/Write Read/write.
Added to API LNS Release 3.20.
FormatLocales
The FormatLocales property contains all the FormatLocale objects that have been added to
the Object Server. It contains four pre-defined FormatLocale objects, which are described
below. The pre-defined FormatLocale objects are read-only, but you can create custom
FormatLocale objects with the Add method.
To retrieve a FormatLocale object from this collection, use the Item property and specify the
object to be retrieved by its index number. The index number will be in the range of 1 to x,
where x represents the value stored in the Count property.
Note that indexes 1, 2, 3 and 4 are assigned to the pre-defined, read-only FormatLocale
objects. The pre-defined FormatLocale objects are listed by index and name, and summarized
as follows:
• Index 1, UserDefaultRegionalSettings. This is the default value for the
CurrentFormatLocale property. When you use this FormatLocale object as the
CurrentFormatLocale, all the properties will be set based on the user-defined Windows
regional settings on the computer running your application. You can change the regional
settings on a computer using the Windows control panel Regional Options applet.
Consult the Microsoft Developer’s Network documentation of the Win32
GetLocaleInfo()
function for more information on this.
• Index 2, SystemDefaultRegionalSettings. When you use this FormatLocale object as
the CurrentFormatLocale, all the properties will be set based on the default Windows
regional settings on the computer running the application. The default settings may
vary, depending on which operating system is installed on the computer. Consult the
Microsoft Developer’s Network documentation of the Win32 GetLocaleInfo() function
for more information on this.
• Index 3, LonMarkCompatibility. When you use this FormatLocale object as the
CurrentFormatLocale, all properties will be set so that all formatted data will be
displayed per LonMark standards used prior to LNS 3.0, when localized formatting was