GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogCreate Function

Overview

The LogCreate function creates a Log Object to allow the writing of log information.

Syntax/Parameters

Syntax

handle = LogCreate ( [string name], [string target] );

Parameters

name

A string representing the name of the log. The name can be used later as a tab name for the information view.

target

A string representing an optional target filename for the log. If set, this becomes the default target file for messages. This can be overridden or later added for individual log entries using the LogSetTarget function.

Return Value

Returns a handle to a Log Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

Log Objects allow for greater flexibility in expressing log information. A Log Object differs from a log file in that characteristics can be set for each log entry. These properties can help organize the log information for display to the user. Messages sent to a Log Object can be exported or shown as an Information View log within the application, which allows the user to interact with the information in a more dynamic and easier manner.

Related Functions

LogDisplay — Displays the specified log as a tab in the Information View window.

LogExport — Exports a specified log to a file as XML, HTML or other formats.

LogImport — Imports a log file into a Log Object.

LogReset — Resets the content of the specified or default log.

LogToHTML — Exports a log to a string as HTML.

LogToTable — Returns the contents of a log in the form of a string table.

LogToText — Exports a log to a string as text.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.