  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFileTypeCode function examines either the file extension or the file header to determine the type of file and returns it as a formatted file type code.
Syntax/Parameters
Syntax
dword = GetFileTypeCode ( string source, [boolean extension_only] );
Parameters
source
A string specifying a qualified source filename to inspect. For maximum flexibility, this file is opened with read access and share write/read.
extension_only
An optional boolean flag that when TRUE causes the function to only examine the extension. The default value is FALSE.
Return Value
Returns a dword as a file type code or a formatted error code on failure.
Remarks
See the introduction to this section for the file codes and their meaning. Note that some file type testers add version bits, which makes a direct comparison impractical. If this function searches only by extension, the file is not opened.
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.