GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ReplaceStringSegment Function

Overview

The ReplaceStringSegment function replaces a specified segment of a source string and returns the adjusted string.

Syntax/Parameters

Syntax

string = ReplaceStringSegment ( string source, string insert, int position, int size );

Parameters

source

A source string.

insert

A string to replace segment with.

position

An int containing the zero-based index specifying the starting position within source of the segment to be deleted.

size

An int containing the size of the segment to delete. 

Return Value

Returns a string with the segment deleted or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The sum of the position and size parameters must be within the length of the source string or the ReplaceStringSegment function will fail. In this case, the GetLastError function will return ERROR_RANGE.

If the insert parameter is empty, the function operates like DeleteStringSegment.

Related Functions

DeleteStringSegment — Deletes the segment from the zero-based position for a specified size.

InsertStringSegment — Inserts a string segment into another string at the zero-based position.

IsInString — Checks for all or part of string or character inside of a target string (like InString but with a boolean result).

FindInString — Finds a string within a string with optional position and case sensitivity.

GetStringSegment — Extracts a section or segment of a string.

ReplaceInString — Replaces matching strings inside another string with or without case sensitivity.

ReplaceInStringRegex — Replaces matching strings inside another string using regular expression rules.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.