  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Two — Language Overview (continued)
TranslateFormattedErrorCode Function
Overview
The TranslateFormattedErrorCode function translates a formatted error code to a string.
Syntax/Parameters
Syntax
string = TranslateFormattedErrorCode ( int code, [boolean terse] );
Parameters
code
An int specifying error code returned by any function supporting formatted error codes.
terse
An optional boolean value specifying whether to return terse or verbose string. The default is verbose.
Return Value
Returns a string containing a descriptive string or and empty string on failure.
Remarks
Terse format returned string is in the following form:
ERROR_suffix [flags] xxxxxxxx (nn)
While the verbose message format:
ERROR_suffix [flags] (info string) xxxxxxxx (nn)
Where flags is additional information such as ERROR_CANCEL_USER, info is a descriptive message which may include windows error code descriptions, xxxxxxxx is an eight character the full error in hexadecimal and nn is the lower code in decimal without leading spaces or zeros.
Example:
ERROR_FILE (API Error. The system cannot find the file specified.) 85000002 (2)
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.