VBScript in a Nutshell

Name

Replace Function

Syntax

Replace(string, stringToReplace, replacementString [, start[, count[, compare]]])

string

Use: Required

Data Subtype: String

The complete string containing the substring to be replaced.

stringToReplace

Use: Required

Data Subtype: String

The substring to be found by the function.

replacementString

Use: Required

Data Subtype: String

The new substring to replace stringToReplace in string.

start

Use: Optional

Data Subtype: Long

The character position in string at which the search for stringToReplace begins.

count

Use: Optional

Data Subtype: Long

The number of instances of stringToReplace to replace.

compare

Use: Optional

Data Subtype: Integer

The method that compares stringToReplace with string ; its value can be vbBinaryCompare or vbTextCompare.

Return Value

The return value from Replace depends on the parameters you specify in the argument list, as the following table shows:

If	Return Value
string = ""	Zero-length string (“”)
string is Null	An error
StringToReplace = ""	Copy of string
replacementString = ""	Copy of string with all instances of stringToReplace removed
start > Len(string)	Zero-length string (“”)
count = 0	Copy of string

Description

Replaces a given number of instances of a specified substring in another string.

Rules at a Glance

• If start is omitted, the search begins at the start of the string.

• If count is omitted, its value defaults to -1, which means that all instances of the substring after start are replaced.

• vbBinaryCompare is ...