Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SixFile Functions (continued)

GetShortPathName Function

Overview

The GetShortPathName function retrieves the 8.3 ASCII short path name for a file.

Syntax/Parameters

Syntax

string = GetShortPathName ( string name );

Parameters

name

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

Return Value

Returns a string containing the short filename or an empty on failure. Use the GetLastError function to retrieve error information.

The last error will be TRUE if the name was converted to a source form or FALSE if name was already in short form.

Remarks

The 8.3 short filename is commonly used in MS-DOS and older versions of Windows. This function runs on Windows and on the VFC only. To retrieve the corrected filename and path, use the GetCorrectedFilename function.

Not all platforms support short filenames. If the platform does not support short names, or the supplied name is 8.2 compliant, the same name is returned as supplied. Use the “fsutil 8dot3name” in the command line to enable short file and path names.

The file must exist for the function to process the request.

Related Functions

Platform Support

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

Legato IDE, Legato Basic