  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFileTypeData function examines a file and returns type characteristics in the form of a string array.
Syntax/Parameters
Syntax
string[] = GetFileTypeData ( string source );
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.
Return Value
Returns a string array containing file type codes or a an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
See the introduction to this section for the file codes and their meaning. The following table contains the possible key names. Not all signature testers return details and some return values are based solely on the file extension.
| Key Name | Description | ||
| FileTypeCode | File type code represented as hex. This code is determined by examining the signature of the file. | ||
| FileTypeString | File type code represented as a token. | ||
| ExtensionTypeCode | File extension type code represented as hex. This is based on the file extension only. | ||
| ExtensionTypeString | File extension type code represented as a token. | ||
| TypeDescription | Descriptive text of the file type. This can sometimes contain additional information. | ||
| VersionGroup | Version information in hex. | ||
| VersionMajor | Major version number in hex. | ||
| VersionMinor | Minor version number in hex. | ||
| FilePath | Path of file being tested. | ||
| FileName | Name of file being tested. | ||
| FileSize | Size of file being tested. | ||
| FileCreateTime | Creation time of file. | ||
| FileModifiedTime | Last write time of file. | ||
| MetaAuthor | Author of file. | ||
| MetaComments | Comments for file. This may contain more EDGAR Information. | ||
| MetaDescription | Description of file. | ||
| MetaKeywords | Keyword of file. | ||
| MetaOptions | Options of file. | ||
| MetaSubject | Subject of file. | ||
| MetaTitle | Title of file. | ||
| Encoding | Specifies the raw encoding of the file. The encoding is detected as part of the file initial signature, usually for text based formats. The value will be one of the following: Unicode — Unicode signature, little endian. Unicode BE — Unicode signature, big endian. UTF-8 — Unicode Transform Format (8-bit) Unknown — A format was not specified. Not all files have encoding specified as the leading signature. Some files may specify encoding within their meta data. For example, XML or HTML may have separate or duplicate meta encoding information. |
||
| ImageColors | If the file type is an image, the colors may be provided in decimal. | ||
| ImageWidth | If the file type is an image, the width may be provided in decimal. | ||
| ImageHeight | If the file type is an image, the height may be provided in decimal. | ||
| TransparentColor | If the file type is an image, the transparent color may be provided in hex. |
Some key fields may be empty depending on the availability of the source information and the complexity of being able to discern such data.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-12-13
| 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.