Contents
Index 🔎︎

# Replace Function

Replaces some string by another.

### Syntax:

Replace (Text As String, SearchStr As String, ReplStr As String [, Start As Long [, Count as Long [, Compare As Boolean]]]

### Return value:

String

### Parameters:

Text: Any string expression that you want to modify.

SearchStr: Any string expression that shall be searched for.

ReplStr: Any string expression that shall replace the found search string.

Start: Numeric expression that indicates the character position where the search starts and also the start of the substring to be returned.

Count: The maximal number of times the replace shall be performed.

Compare: Optional boolean expression that defines the type of comparison. The value of this parameter can be TRUE or FALSE. The default value of TRUE specifies a text comparison that is not case-sensitive. The value of FALSE specifies a binary comparison that is case-sensitive. You can as well use 0 instead of FALSE or 1 instead of TRUE.

### Error codes:

D'oh! You found a bug (text/sbasic/shared/00000003.xhp#err5 not found).

### Example:

            msgbox replace ("aBbcnnbnn", "b", "$", 1, 1, FALSE)'returns "aB$cnnbnn"
            REM meaning: "b" should be replaced, but
            REM * only when lowercase (parameter 6), hence second occurrence of "b"
            REM * only first (respecting case) occurrence (parameter 5)
            msgbox replace ("ABCDEFGHI", "E", "*", 4)
            REM returns D*FGHI because the search starts at position 4, which is also the start of the returned string.