  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
ExpandEnvironmentalStrings Function
Overview
The ExpandEnvironmentalStrings function takes an incoming string and expands any environmental variable references such as “%appdata%” or %temp%.
Syntax/Parameters
Syntax
string = ExpandEnvironmentalStrings ( string source );
Parameters
source
A string containing the string to be expanded. The string is assumed to be UTF-8 encoded. The string cannot be more than 32,768 characters in size.
Return Value
A string containing the encoded version of source or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
Windows maintains a table of environmental variables for each process. In addition, there are certain reserved terms processed by the function specific to Novaworks applications.
The maximum size of the buffer is 32K although the return string could potentially be larger if variables are replaced with larger strings.
The Novaworks reserved variables are as follows:
%AppPath% — Application’s program folder.
%DesktopPath% — Path for the user’s desktop.
%DocumentsPath% — Path for the user’s My Document folder.
%MyProjectsPath% — Path for the defined projects path.
%ProjectPath% — Path for the currently open project.
Variable names are not case-sensitive.
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.