  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The ForceScriptError function sets a processing error and causes the script to unwind.
Syntax/Parameters
Syntax
int = ForceScriptError ( dword code );
Parameters
code
A dword to pass as the error. The value must have the top bit set to indicate an error condition (ERROR_BIT or 0x80000000).
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure.
Remarks
Forcing an error is processed in the same manner as a runtime error. This can allow the unwind function to be passed an error code or condition or allow for exception testing during debugging.
Since the script will process this as a runtime error, an error will be added to the runtime log. In addition, the ERROR_REPORTED (0x00800000) bit will be set as the code is added to the log.
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.