  |
GoFiler Legato Script Reference
Legato v 1.6f Application v 6.4a
|
| Table of Contents | < < Previous | Next >> |
Chapter Sixteen — Application (continued)
Overview
The SetPreference function sets a specific application preference.
Syntax/Parameters
Syntax
int = SetPreference ( string section, string name, string value, [boolean retain] );
Parameters
section
A string specifying a predefined section name.
name
A string specifying a predefined setting name.
value
A string specifying the value to set as a preference.
retain
An optional boolean values specifying whether to save the preferences on success. The default value is FALSE.
Return Value
An int as ERROR_NONE or a formatted error code on failure.
Remarks
The SetPreference function allows a single application to be set either on a temporary or permanent basis.
Placing line ending characters (“\r” 0x0D or “\n” 0x0A) in any of the string parameters will result in a run time parameter error.
SetPreference broadcasts the parameter to change to all the modules within the application. As such, the section and name values must be known within the application for the action to take effect. If the values specify and new or incorrect location, the function will not return an error. This is akin to adding an item to an INI file that is not observed by the application. Settings that are not known will not be saved if the retain flag is set.
If the multiple settings are going to be set and saved, set the retain parameter on the last call to the SetPreference function. This will reduce processing time.
Note that on startup, certain deployment schemes may override the setting(s) even if the retain parameter is set to true.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE
Page revised 2026-01-05
| Table of Contents | < < Previous | Next >> |
© 2012-2025 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission is prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. Novaworks, GoFiler™ and Legato™ are registered 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 the 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.