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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ReplaceInStringRegex Function

Overview

The ReplaceInStringRegex function locates a search string and replaces it with another string. The search can be performed with or without regard to text case.

Syntax/Parameters

Syntax

string = ReplaceInStringRegex ( string source, string pattern, string replace );

Parameters

source

A string to search.

pattern

A string segment to match using regular expression rules.

replace

A string segment with which to replace the find segment.

Return Value

Returns a string with each instance of find replaced with target or an empty string on failure. Use the GetLastError function to retrieve error information. If the pattern contains a syntax error or the process results in an endless recursion, the returned error code will be ERROR_SYNTAX, otherwise it will be TRUE (non-error).

Remarks

The ReplaceInStringRegex function will replace every occurrence of the pattern string within source with the replace string. If no matches are found, the original string is returned. This is not considered an error. Certain pattern match and replace can result in recursion errors.

For information about the language elements used to build a regular expression pattern, see Regular Expression Language - Quick Reference in MSDN.

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

Related Functions

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

InString — Tests for a string as part of a target string with or without case sensitivity.

IsInString — Checks for a string or character matching inside a target string.

IsRegexMatch — Performs a regular expression pattern match on string data.

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

ReplaceStringSegment — Replaces a specified segment within a string with another string.

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.