Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6c

Application v 6.1a

  

 

Chapter SixteenApplication (continued)

EventLogSetOption Function

Overview

The EventLogSetOption function sets a predefined Event Log Object setting.

Syntax/Parameters

Syntax

string = EventLogSetOption ( handle hObject, string setting, string state );

Parameters

hObject

A handle to an Event Log Object.

setting

A string specifying a setting name.

state

A string specifying a setting value. Generally, “1” or “true”, any other values are treated as false. See the IsTrue function for valid true strings.

Return Value

A string containing the state of the previous setting value or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The setting can be one of the following:

“Timestamps” — Indicates whether time stamps are enabled for log messages. [By default, time stamps are added to log entries.]

“Line Endings” — Indicates whether line ending are automatically added to message as they added to the log. [By default, line endings are added to log entries.]

Both the setting and state parameters are case insensitive.

Related Functions:

Platform Support

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

Legato IDE

Page revised 2025-06-16