Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetDesktopFolder Function

Overview

The GetDesktopFolder function returns the path to the current user’s desktop folder.

Syntax/Parameters

Syntax

string = GetDesktopFolder ( );

Parameters

(none)

 

Return Value

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

Remarks

The location of the user’s desktop folder depends upon the version of Windows under which the GetDesktopFolder function is being called and whether the user is running under a roaming profile. The string will always be returned with a trailing backslash to allow the simple addition of file or further path information.

Related Functions

Platform Support

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

Legato IDE, Legato Basic