GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

GetLocalTimeForZone Function

Overview

The GetLocalTimeForZone function returns the local time for a specified time zone as a string or a date-time qword.

Syntax/Parameters

Syntax

string = GetLocalTimeForZone ( string zone, int format );

qword  = GetLocalTimeForZone ( string zone );

Parameters

zone

A string specifying the full name of a time zone to retrieve the date and time.

format

An optional int containing bitwise flags to direct date formatting. This parameter must be specified in order to return a string value for the date and time; otherwise the return value is a qword. See the date string (DS_) format codes in Section 5.12 Date and Time Functions for more information.

Return Value

Returns a string if format is set or a date-time qword if it is not. The value will be empty or zero on error. Use the GetLastError function to retrieve a formatted error code.

Remarks

The zone parameter must match one of the enumerate time zones for the operating system.

Related Functions

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

FormatDate — Formats time value (file time) to a date string.

GetLocalTime — Gets local time and date in file time (default) or specified string format.

GetUTCTime — Gets current UTC time and date in file time (default) or specified string format.

LocalToUTC — Converts local time (current time zone) to UTC in file time or string format.

UTCToLocal — Converts UTC file time to local time (current time zone) in file time or string format.

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 10/21/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.