Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

PoolGetString Function

Overview

The PoolGetString function retrieves a string from a specified offset position.

Syntax/Parameters

Syntax

string = PoolGetString ( handle hPool, [int offset] );

Parameters

hPool

A handle specifying the String Pool Object.

offset

An optional int specifying a location within the String Pool object from which to retrieve the string. If the parameter is omitted, the value will be 0 or the start of the pool.

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

The PoolGetString function can be used in conjunction with the PoolPut function to store strings and later retrieve them by offset.

Related Functions

Platform Support

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

Legato IDE, Legato Basic