GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogExport Function

Overview

The LogExport function exports a log object to file in a specified format. The only format that maintains the complete content of the log is the XML export.

Syntax/Parameters

Syntax

int = LogExport ( [handle hLogObject], string filename );

Parameters

hLogObject

A handle to a Log Object created with the LogCreate function. If omitted or NULL_HANDLE (0) specified, the function will apply to the default log.

filename

A string specifying the filename and path to export the log. The extension of the filename determines the format.

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 log object can be exported in one of four formats: XML, Text, HTML and CSV. The Text and HTML formats are designed principally for display purposes. the CSV format lists every log entry with most of the raw detail. See the InfoView and Log File Format Specification for information on the XML log format.

Once exported, the XML log format can be opened directly in many host applications.

Related Functions

AddMessage — Adds a formatted message to the default or a specified log, or other object.

LogCreate — Creates a general log object with an optional log name and target filename base.

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 12/16/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.