  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFileSize function retrieves the size of a specified file, a file object, or a Folder Enumeration Object as a number of bytes.
Syntax/Parameters
Syntax
qword = GetFileSize ( 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 size of the file or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
Note if an int datatype is used to receive the size, the maximum file size that will be accurately returned is approximately 2.1GB. Files larger than 2.1GB will return an undefined value and a value truncation warning will be placed into the runtime log.
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.