Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

PoolAppendNewLine Function

Overview

The PoolAppendNewLine function appends a line ending (new line) as CR/LR or CR depending on the new lines mode.

Syntax/Parameters

Syntax

int = PoolAppendNewLine ( handle hPool, [int lines] );

Parameters

hPool

A handle specifying the String Pool Object.

lines

An int specifying the number of lines to add. The default is 1 and the value must be from 0 to 1000. If the value is zero, the function essentially does nothing.

Return Value

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

Remarks

While new line codes can be embedded in the appended strings, this function allows for the control of the type of line endings. Use the PoolSetNewLineMode function to set the mode of the line endings.

Related Functions

Platform Support

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

Legato IDE, Legato Basic