GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Six — File 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

GetCorrectedFilename — Gets a corrected long filename (i.e., converts an 8.3 style name to a Windows long name).

GetLongFilename — Returns a corrected long filename (no path) for specified string (filename and path).

GetLongPathName — Returns a corrected long path name for a specified string (filename and path).

GetShortFilename — Returns an 8.3 short filename (no path) for specified string (filename and path).

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 12/16/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.