GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

GetTimeZoneInformation Function

Overview

The GetTimeZoneInformation function returns the computer’s local time shift as bias minutes from GMT or UTC.

Syntax/Parameters

Syntax

string [] = GetTimeZoneInformation ( [string zone] );

Parameters

zone

An optional string specifying the full name of a time zone to retrieve the bias. If omitted, the local time zone is used.

Return Value

Returns a string array with various time zone parameters or an empty array on failure. Use GetLastError to retrieve a formatted error code.

Remarks

An array is returned with information about the current time zone and parameters regarding daylight savings time switch over. The keys are as follows:

	Key Name		Description
	current_bias		A decimal string representing current time zone bias from UTC.
	standard_name		Standard time name, verbose, UTF-8. A description for standard time. For example, Eastern Standard Time indicated “EST”. This string can be empty.
	standard_bias		The bias value to be used during local time translations that occur during standard time. This member is ignored if a value for the standard_switch_over value is “none”. This value is added to the value of the current_bias value to form the bias used during standard time. In most time zones, the value of this member is zero.
	standard_switch_over		A text description of the switch over date in the form of the day of the week and time. For example: First Sunday of November at 02:00 AM If the switch over is not supported, the value will be “none”
	daylight_name		Daylight time name, verbose, UTF-8. A description for standard time. For example, Eastern Daylight Time indicated “EDT”. This string can be empty.
	daylight_bias		The bias value to be used during local time translations that occur during standard time. This member is ignored if a value for the daylight_switch_over value is “none”. This value is added to the value of the current_bias value to form the bias used during standard time. In most time zones, the value of this member is zero.
	daylight_switch_over		A text description of the switch over date in the form of the day of the week and time. For example:  First Monday of March at 02:00 AM If the switch over is not supported the value will be “none”

 

This function ignores a locale override for the application.

Related Functions

EnumerateTimeZones — Returns a list of all known time zones for the system.

GetLocalTimeForZone — Gets the local time and date for a specific zone.

GetTimeZoneOverride — Returns Time Zone Override.

GetTimeZoneBias — Returns the difference between the locale and UTC in minutes.

IsDaylightSavingsTime — Tests whether the current locale is operating under daylight savings time.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.