Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetCorrectedFilename Function

Overview

The GetCorrectedFilename function retrieves the corrected filename and path for a file.

Syntax/Parameters

Syntax

string = GetCorrectedFilename ( string file );

Parameters

file

A string containing a qualified filename and path. This parameter supports UTF encoding for filenames with Unicode characters.

Return Value

Returns a string containing the corrected/adjusted name and path or an empty string on failure. Use the GetLastError function to retrieve error information.

The return value is be UTF encoded to support filenames with Unicode characters.

Remarks

Because Windows filenames are case-insensitive, the GetCorrectedFilename function allows for retrieving the actual filename. It adjusts for proper case and formatting, including converting 8.3 filenames (short filenames) and paths that are commonly used in old versions of DOS and Windows to the actual filename. This function runs on Windows and on the VFC only.

Related Functions

Platform Support

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

Legato IDE, Legato Basic