  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LogOutdent function outdents the log information (moves the spacing to the left) by a specified or default amount.
Syntax/Parameters
Syntax
int = LogOutdent ( [handle hLogObject], [int value] );
Parameters
hLogObject
A 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.
value
An optional int specifying the indent value. If omitted, the value will be 5 spaces. The value can be positive or negative but can to be larger than 40 or smaller than -40.
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 LogOutdent function can be used to aid in grouping data within the log. The indent is subtracted to the current indent value for the specified (or default) log. The resulting indent value cannot be less than 0 and will be forced to 0 if it falls below it. Note that specifying a positive value for the value parameter will indent the text (move it to the right, which produces the same result as using the LogIndent function).
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.