Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

PoolGetPool Function

Overview

The PoolGetPool function returns a string copy of the String Pool Object.

Syntax/Parameters

Syntax

string = PoolGetPool ( handle hPool );

Parameters

hPool

A handle specifying the String Pool Object.

Return Value

Returns a string representing the first zero-terminated string within the pool or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

Generally the PoolGetPool function is used with contiguous string pools where strings or data has been appended as opposed to using the PoolPut function which will intersperse /0 bytes in the pool. This function operates in the same manner as calling PoolGetString with an offset of 0.

Related Functions

Platform Support

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

Legato IDE, Legato Basic