Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

GetLocalTime Function

Overview

The GetLocalTime function returns the computer’s local time as a string or a date-time qword.

Syntax/Parameters

Syntax

string = GetLocalTime ( int format );

qword  = GetLocalTime ( );

Parameters

format

An optional int containing bitwise flags for a 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.

Remarks

Unless otherwise specified, the string value is adjusted by the system for the time zone and daylight savings time. The DS_FILETIME_UTC parameter has no effect.

Note that file times are generally UTC and this function will provide a local time version of that value. Most functions expect the file time to be in UTC. Passing the file time to a function such as FormatDate will generally result in the wrong time zone being processed.

This function is subject to locale time zone override for the application.

Related Functions

Platform Support

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

Legato IDE, Legato Basic