Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

InsertStringSegment Function

Overview

The InsertStringSegment function inserts one string into another at a specified position.

Syntax/Parameters

Syntax

string = InsertStringSegment ( string target, string insert, int position );

wstring = InsertStringSegment ( wstring target, wstring insert, int position );

Parameters

target

A string or wstring into which insert will be inserted.

insert

A string or wstring to insert. The string type of target and insert must match. If not, a runtime error will occur.

position

An int containing a zero-based position at which the string will be inserted.

Return Value

Returns a string or wstring composed of target with insert placed at position or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The return data type depends on the source string types. If position was beyond the end of the target string, the GetLastError function will return ERROR_RANGE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic