Owner manual

OpenLNS Programmer's Reference 327
less than or equal to the receive
timeout value.
The default value is 0,which means
that OpenLNS calculates the timeout
period based on the network topology
and channel delays.
fileTransObject
The FileTransfer object to be acted on.
Data Type
Integer.
Read/Write
Read/write.
Added to API
Prior to LNS Release 3.0.
FormatLocale
A FormatLocale object contains a series of properties that reflect a particular geographical
area’s conventions for data display. These conventions affect how data should be displayed in
that area, including factors such as language, measurement system, date formats, time
formats, and decimal number formats. The settings of a FormatLocale object determine how
data stored in the FormattedValue properties of all DataPoint objects will be displayed when
the FormatLocale object is used by an application.
The FormatLocales collection contains 4 pre-defined, read-only FormatLocale objects. For
more information on the pre-defined FormatLocale objects, see the online help for the
FormatLocales collection.
You can create custom FormatLocale objects with the Add method; however, your application
can only use one FormatLocale object at a time. You can determine which FormatLocale
object will be used by your application by writing to the CurrentFormatLocale property of the
ObjectServer object.
Note: You can only write to the CurrentFormatLocale property, or modify 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 the
FormatLocale object assigned to the property) after performing any of these operations, the
LCA, #122 lcaErrReadOnlyInContext exception will be thrown.
In addition, the Object Server contains four pre-defined FormatLocale objects using index
values 1, 2, 3 and 4. All attributes of these FormatLocale objects are read-only.
The following table summarizes the FormatLocale object.
Description
Contains a series of properties that reflect a particular
geographical area’s conventions for data display.
Added to API
LNS Release 3.20.
Accessed Through
FormatLocales collection object.
Default Property
None.
Methods
None.
Properties
• CategoryPreferenceList
• ClassId