  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The SetLastError function allows a function to set the global error code and message for the script.
Syntax/Parameters
Syntax
int = SetLastError ( int code, [string message], [parameters ... ] );
Parameters
code
An integer or dword value to which the last error will be set. Do not set a value grater than 0xFFFFFFFF or an overflow error will occur.
message
An optional string to which the associated extended text message will be set. This value cannot be more that 256 characters in size. If omitted, the text portion is set to an empty string. If additional parameters are present, message is considered a formatted string. See Section 5.2 String Functions for more information on formatted strings.
parameters
Zero or more parameters to be formatted and inserted into message. If no parameters are supplied, message is simply passed through to the result string.
Return Value
Returns an int as ERROR_NONE.
Remarks
The SetLastError function provides an easy way to pass additional error information back to a caller. The values are subject to be reset anytime an SDK function is called.
The last error code can also be access by other application functions such as menu and other hooks.
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.