Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

PoolOverlay Function

Overview

The PoolOverlay function will overwrite a specified section of a String Pool Object.

Syntax/Parameters

Syntax

int = PoolOverlay ( handle hPool, int offset, string value, [boolean mode] );

Parameters

hPool

A handle specifying the String Pool Object.

offset

An int specifying the position within the pool at which to perform the overlay.

value

A string value to lay over the pool at offset. The size of the string plus the offset must be within the scope the data within the pool.

mode

An optional boolean value specifying whether to add a terminating /0 byte as the string is layered. If mode is FALSE. the string is laid on top of the existing data and no additional /0 terminator is added. The default is FALSE.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

Overlaying a string with a terminator can result in the pool being “chopped” such that certain areas not be easily accessible. Further, the PoolGetPool function will not return the entire pool.

Related Functions

Platform Support

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

Legato IDE, Legato Basic