Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetFileTypeString Function

Overview

The GetFileTypeString function examines either the file extension or the file header to determine the type of file and returns it as a string.

Syntax/Parameters

Syntax

string = GetFileTypeString ( 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 string as a file type code or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

See the introduction to this section for the file codes and their meaning. 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