Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ThreeData Types and Operators (continued)

GetWorkingPoolSize Function

Overview

The GetWorkingPoolSize function returns the size of the internal working string pool.

Syntax/Parameters

Syntax

int = GetWorkingPoolSize ( [int mode] );

Parameters

mode

An int specifying the storage mode. The values are as follows:

0 – Total allocated size.

1 – Size of area currently being used.

2 – Unused portion of the pool.

The default value is 0.

Return Value

Returns an int containing the size in bytes.

Remarks

Each script engine will employ an internal working string pool that is used to store data being passed to various functions internally. GetWorkingPoolSize is a tool to help understand how much memory is being used to transition data.

Transitional data is information used to perform string math and functions. For example, if FileToString is run, the result is placed on the working string pool and then stored in memory. The remaining space in the working pool is reused but not released.

Related Functions

Platform Support

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

Legato IDE, Legato Basic