Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixteenApplication (continued)

DisableFileHistory Function

Overview

The DisableFileHistory function controls the addition of files to the file history list.

Syntax/Parameters

Syntax

int = DisableFileHistory ( [int mode] );

Parameters

mode

An optional int specifying whether to disable (FALSE), enable (TRUE) or to read the blocking state (-1). The default value is TRUE.

Return Value

An int containing the current add status. If not blocked, FALSE is returned, if adding file action is blocked, FALSE is returned.

Remarks

While running certain menu functions (and some other view level functions), edit files might be opened and closed. This action will result in the filename a path being added to the file history. To block this action, call this function.

The blocking action can be removed by calling with function with the mode set to FALSE.

Blacking action is cumulative from script to script, as such, the file history could already be blocked. In this case, calling the DisableFileHistory will just increment the application level count.

If the program ends without reenabling the file history, script engine will automatically restore the blocking to its original state,

Related Functions:

Platform Support

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

Legato IDE