Returns a string in which a specified substring has been replaced with another substring a specified number of times.
Replace(expression, find, replacewith[, Start[, count[, compare]]])
The Replace syntax has these parts:
| Part | Description |
|---|---|
| expression | Required. String expression containing substring to replace. |
| find | Required. Substring being searched for. |
| replacewith | Required. Replacement substring. |
| Start | Optional. Position within expression where substring search is to begin. If omitted, 1 is assumed. |
| count | Optional. Number of substring substitutions to perform. If omitted, the default value is -1, which means make all possible substitutions. |
| compare | Optional. Numeric value indicating the kind of comparison to use when evaluating substrings. See Settings section for values. |
The compare argument can have the following values:
| Constant | Value | Description |
|---|---|---|
| vbBinaryCompare | 0 | Perform a binary comparison. |
| vbTextCompare | 1 | Perform a textual comparison. |
| vbDatabaseCompare | 2 | Perform a comparison based on information contained in the database where the comparison is to be performed. |
Replace returns the following values:
| If | Replace returns |
|---|---|
| expression is zero-length | Zero-length string (""). |
| expression is Null | An error. |
| find is zero-length | Copy of expression |
| replacewith is zero-length | Copy of expression with all occurences of find removed. |
| Start > Len(expression) | Zero-length string. |
| count is 0 | Copy of expression |
The return value of the Replace is a string, with substitutions made, that begins at the position specified by Start and and concludes at the end of the expression string. It is not a copy of the original string from Start to finish.