Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetFileCreateTime Function

Overview

The GetFileCreateTime function retrieves the creation time for a specified file, a Basic File or Folder Enumeration Object as a qword.

Syntax/Parameters

Syntax

qword = GetFileCreateTime ( mixed file );

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.

Return Value

Returns a qword containing the file creation time in milliseconds since January 1, 1601 (UTC) or -1 on failure. Use the GetLastError function to retrieve error information.

Remarks

The returned time is always in UTC or Zulu time (Z). The resolution of the time value is dependent on the underlying file system.

For more information on the return value, see the Windows FILETIME structure in the Windows SDK. To convert the return value to a string, use the FormatDate function. To retrieve the file creation time as a string, use the GetFileCreateTimeString 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