Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

GetTimeZoneOverride Function

Overview

The GetTimeZoneOverride function returns the status of a local time zone override.

Syntax/Parameters

Syntax

string = GetTimeZoneOverride ( );

Parameters

(none)

 

Return Value

Returns a string with the name of the time zone be used as a locale override or empty on failure. Empty can also mean there is not an override. Use GetLastError or IsError to determine if an error occurred or the locale is GMT. GetLastErrorMessage can be used to determine if there was an error set by the override.

Remarks

A time zone override is set within the application ini file using the following code:

[Locale Override]

Time Zone=Pacific Standard Time

The time zone name must match a Windows defined name. If an error occurs during setup, the error detail will be placed in the string retrieved through the GetLastErrorMessage function.

Note that this setting is read the first time a local date is requested, which of course occurs on application startup while building the application log. If an error occurs, the ini entry must be corrected and the application restarted.

If the time zone has been overridden, the GetLocalTimeForZone function can be used to get the time for the computer’s locale.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic