Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

PoolAppendAsXString Function

Overview

The PoolAppendAsXString function adds a converted version of a specified string to a String Pool Object.

Syntax/Parameters

Syntax

int = PoolAppendAsXString ( handle hPool, string data );

Parameters

hPool

A handle specifying the String Pool Object.

data

A string to add to the pool. This string will be processed during the append process.

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 PoolAppendAsXString 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. The source string is processed to be XML CDATA compatible by converting escaped characters and information to UTF-8 as needed.

Related Functions

Platform Support

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

Legato IDE, Legato Basic