Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter FiveGeneral Functions (continued)

LogDisplayDialog Function

Overview

The LogDisplayDialog function displays the specified log in a results style dialog.

Syntax/Parameters

Syntax

int = LogDisplayDialog ( handle hLogObject, [string name], [dword options] );

Parameters

hLogObject

A handle to a Log Object created with the LogCreate or retrieved with the GetDefaultLog function.

name

An optional string specifying a dialog caption name. The string cannot be larger that 256 characters.

options

An optional dword that sets options for the display of the data and the dialog itself

Return Value

Returns an int as ERROR_NONE, ERROR_CANCEL, IDYES,, IDNO a or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

The LogDisplayDialog works a little like a message box but displays a log. By default, the dialog will display a list and a sime “OK” button, By using the options, additional buttons and display features can be enabled. These are as follows:

  Definition   Bitwise   Description  
  Display (bitwise)          
    RESULT_LIST_SMALL   0x00010000   Use Small Dialog  
    RESULT_LIST_DISPLAY_POSITION   0x00020000   Add X/Y Position  
    RESULT_LIST_DISPLAY_COLOR   0x00040000   Color Code Errors  
  Button Mode (select only one)           
    RESULT_LIST_BUTTOM_MASK   0x0000000F   Button Mode  
    RESULT_LIST_OK   0x00000000   OK Button  
    RESULT_LIST_OK_CANCEL   0x00000001   OK/Cancel Buttons  
    RESULT_LIST_YES_NO   0x00000002   Yes/No Buttons  
    RESULT_LIST_YES_NO_CANCEL   0x00000003   Yes/No/ Cancel Buttons  

 

Related Functions

Platform Support

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

Page revised 2025-08-15