Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter SixFile Functions (continued)

GetFileModifiedTimeString Function

Overview

The GetFileModifiedTimeString function retrieves the last time a file was modified (written to) for a specified file, a Basic File or Folder Enumeration Object as a string.

Syntax/Parameters

Syntax

string = GetFileCreateTimeString ( mixed object, [int format] );

Parameters

file

A string containing a qualified file name and path. This parameter supports UTF encoding for filenames with Unicode characters. Or,

a handle to either a file (such as one opened with the OpenFile or CreateFile functions) an FTP connection object or a folder enumeration object.

format

An optional int containing bitwise flags for date formatting. See the Section 5.12 Date and Time Functions for a list of applicable flags. The default value is DS_ISO_8601 in local time.

Return Value

Returns a string containing the file modification time or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The underlying time is always in UTC or Zulu time (Z) the resolution of which is dependent on the underlying file system. By default, the time is converted to local time unless the DS_FILETIME_UTC flag is added to the format parameter.

Note that opening a file with write permissions does not alter its modification date. To retrieve the file modification time as a qword, use the GetFileModifiedTime function.

Note that when retrieving times from an FTP connection, the file times are generally the local time for the specified server.

If the file parameter is not valid, the GetLastError function will return ERROR_INVALID_HANDLE or ERROR_FILE

Related Functions

Platform Support

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

Legato IDE, Legato Basic