Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

GetDefaultLog Function

Overview

The GetDefaultLog function returns the handle to the internal default output log object.

Syntax/Parameters

Syntax

handle = GetDefaultLog ( );

Parameters

(none)

Return Value

Returns a handle for the internal default log object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

Note that many log functions automatically reference the default log handle when the handle is omitted from input parameters. The handle returned by the GetDefaultLog function can be used when passing the log object to higher level functions, such as converting or exporting the log and other application level interfaces.

After retrieving the default log handle, it does not have to be closed. The CloseHandle function will not impact the handle.

Related Functions

Platform Support

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

Legato IDE, Legato Basic