  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LogDisplay function displays the specified log in the Information View window of the Application Desktop.
Syntax/Parameters
Syntax
int = LogDisplay ( [handle hLogObject], [string name], [string target] );
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.
name
An optional string specifying a tab name. The log must have a name specified here as a parameter to this function or when the Log Object was created for the tab to display a name.
target
An optional string that specifies a fully qualified filename to reference as a target for messages. If a target is not specified when adding a message, this name is used as a default. When a user clicks or double clicks on a log message in the Information View, this file is referenced.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.
Remarks
Sending the log to the Information View with the LogDisplay function allows the user to interact with log information dynamically and easily within the Application Desktop. There presently is no method to add an icon to the displayed tab within the Information View.
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.