Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

GetApplicationDataCommonFolder Function

Overview

The GetApplicationDataCommonFolder function returns the global or common folder (for all users).

Syntax/Parameters

Syntax

string = GetApplicationDataCommonFolder ( [boolean base] );

Parameters

base

An optional boolean value specifying whether to return the base data path for all applications or for the application running the script. TRUE returns the base path while the default, FALSE, returns the path for the application.

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 common application data path depends upon the version of Windows under which the GetApplicationDataCommonFolder function is being called and the installation of the application. 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