  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
GetApplicationDataFolder Function
Overview
The GetApplicationDataFolder function returns the current user’s roaming or local application data path.
Syntax/Parameters
Syntax
string = GetApplicationDataFolder ( [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 application data path depends upon the version of Windows under which the GetApplicationDataFolder function is being called and whether the user is running under a roaming profile. There are potentially three different locations of application data: global or common (for all users), roaming for the current user, and local for the current user. Depending on the installation of the software, one or more of these paths may be different. The GetApplicationDataFolder function will return either the current user’s local or roaming data path.
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
| Table of Contents | < < Previous | Next >> |
© 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.