Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

PoolSetNewLineMode Function

Overview

The PoolSetNewLineMode function sets the type of line endings to be added when using the PoolAppendNewLine function.

Syntax/Parameters

Syntax

int = PoolSetNewLineMode ( handle hPool, [int mode] );

Parameters

hPool

A handle specifying the String Pool object.

mode

A int value set to:

SPO_SNLF_NO_NEW_LINES    0   No New Lines, Same as False

SPO_SNLF_CR_LF           1   Return and New Line, Same as True

SPO_SNLF_LF_ONLY         2   New Line Only

The default value is SPO_SNLF_CR_LF.

Return Value

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

Remarks

When a String Pool object is created using the PoolCreate function, the default mode is CR only. This function does not process inline return characters during an append. It only affects the PoolAppendNewLine function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic