GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Six — File Functions (continued)

GetFileTypeData Function

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.

	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.
	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.

Related Functions

GetFileTypeCode — Gets file type by file content or extension and return type as code dword.

GetFileTypeString — Gets file type by file content or extension and return type as string.

FileTypeCodeToString — Translates a file type code dword to a string.

FileTypeStringToCode — Translates a file type code string to a dword.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.