GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ReplaceInString Function

Overview

The ReplaceInString 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  = ReplaceInString ( string source, string find, string replace,
                       [boolean case] );

wstring = ReplaceInString ( wstring source, wstring find, wstring replace,
                       [boolean case] );

Parameters

source

A string or wstring to search.

find

A string or wstring segment to find.

replace

A string or wstring segment with which to replace the find segment.

case

An optional int flag to specify case insensitivity:

TRUE  = case-insensitive

FALSE = case-sensitive

By default. the search is case-sensitive.

Return Value

Returns a string or wstring with each instance of find replaced with target or an empty string on failure. Use the GetLastError function to retrieve error information. If no instances of the find string are found, GetLastError will return ERROR_EOD (0x8100000), otherwise during normal operation, the GetLastError will return the number of items replaced.

Remarks

The ReplaceInString function will replace every occurrence of the find string within source with the replace string. If no matches are found, the original string is returned.

The string type used determines the returned data type. All string value data types must match otherwise a runtime error will be reported and the script stopped.

The return string has a maximum size of 4MB for 8-bit values and 2MB for 16-bit values. If the buffer is exceeded, the GetLastError function will return ERROR_OVERFLOW.

Case-insensitive matching is performed on a locale basis as set by Windows. For US, on ASCII matching is the only case matching performed.

Related Functions

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.

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

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

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 12/16/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.