  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LogAddErrorSummary function appends an error summary to the end of a log.
Syntax/Parameters
Syntax
int = LogAddErrorSummary ( [handle hLogObject], [int always] );
Parameters
hLogObject
The handle to a Log Object created with the LogCreate function. If this handle is omitted or NULL_HANDLE is specified, the function will apply the error summary to the default log.
always
When specified as TRUE, the log summary is always added. If this parameter is omitted or FALSE, the message is only added if there are one or more warnings or errors within the specified log.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.
Remarks
The LogAddErrorSummary function appends the text to the current position. The function performs smart style formatting, in which the line added will be grammatically correct for the number of errors produced. For example, for no errors:
This is a log test message
Total no errors, no warnings
For one error:
This is a log test message
Total 1 error, no warnings
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.