  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
GetFileCreateTimeString Function
Overview
The GetFileCreateTimeString function retrieves the creation time 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 a date formatting. See 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 creation 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.
To retrieve the file creation time as a qword, use the GetFileCreateTime 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
| Table of Contents | < < Previous | Next >> |
© 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.