Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

AppendWithDelimiter Function

Overview

The AppendWithDelimiter function appends one string to another using a delimiter.

Syntax/Parameters

Syntax

string = AppendWithDelimiter ( string base, string new, [string delimiter] );

Parameters

base

A string to which new will be appended.

new

A string that will be appended to base.

delimiter

An optional string containing a delimiter. The default delimiter is a comma followed by a space (“, ”).

Return Value

Returns a string containing base with new appended on success or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The delimiter is only used if the base contains data. This function is useful for creating lists, formal or informal. For example:

string s1;

s1 = AppendWithDelimiter(s1, "computers");

s1 = AppendWithDelimiter(s1, "monitors");

s1 = AppendWithDelimiter(s1, "keyboards");

s1 = AppendWithDelimiter(s1, "mice");

s1 = AppendWithDelimiter(s1, "other equipment", " and ");

 

Would yield “computers, monitors, keyboards, mice and other equipment” contained in s1.

The return string has a maximum size of 1 MB. If the buffer is exceeded, the GetLastError function will return ERROR_OVERFLOW.

Platform Support

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

Legato IDE, Legato Basic