  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The SetScriptDescription function sets the script’s description.
Syntax/Parameters
Syntax
string = SetScriptDescription ( string value );
Parameters
value
A string containing the new script description. The string cannot be larger than 512 characters.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. The only failure mode is a string overflow in which case the string is truncated before setting the script name.
Remarks
The script description can be used to help identify the script. It is not used directly by any function except for retrieving the name or when scripts are enumerated.
Any syntax can be used for the string.
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.