Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

PoolAppend Function

Overview

The PoolAppend function adds a specified string to a String Pool object.

Syntax/Parameters

Syntax

int = PoolAppend ( handle hPool, string data );

Parameters

hPool

A handle specifying the String Pool object.

data

A string to add to the pool.

Return Value

Returns an int containing the offset (location) where the appended string starts within the pool or a formatted error code on failure.

Remarks

The PoolAppend function converts and adds the resulting characters to the existing string end position. The new string is concatenated with the existing strings in the pool. If the PoolPut or PoolOverlay functions are not used, the pool will consist of a single contiguous string.

It is generally recommended to use the PoolAppendNewLine function to add line endings if it is desired to control the types of the endings. However, \r and \n sequence can also be embedded directly into the value string. These are not impacted by the new line settings.

Related Functions

Platform Support

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

Legato IDE, Legato Basic