Sun Chili!Soft ASP Sun Chili!Soft
ASP Sun Microsystems

 

VBScript Replace Function

Returns a string in which a specified substring has been replaced with another substring a specified number of times.

Syntax: VBScript Replace Function

Replace(expression, find, replacewith[, start[, count[, compare]]])

Arguments: VBScript Replace Function

expression

A string expression containing substring to replace. Required.

find

The substring being searched for. Required.

replacewith

The replacement substring. Required.

start

The position within expression where substring search is to begin. If omitted, 1 is assumed. Optional.

count

The number of substring substitutions to perform. If omitted, the default value is -1, which means make all possible substitutions. Optional.

compare

The numeric value indicating the kind of comparison to use when evaluating substrings. See Settings section for values. Optional.

Settings: VBScript Replace Function

The compare argument can have the following values:

Constant

Value

Description

vbBinaryCompare

0

Perform a binary comparison.

vbTextCompare

1

Perform a textual comparison.

Return Values: VBScript Replace Function

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 occurrences of find removed.

start > Len(expression)

Zero-length string.

count is 0

Copy of expression.

Remarks: VBScript Replace Function

The return value of the Replace function is a string, with substitutions made, that begins at the position specified by start and concludes at the end of the expression string. It is not a copy of the original string from start to finish.

The following example uses the Replace function to return a string:

Dim MyString

MyString = Replace("XXpXXPXXp", "p", "Y")   ' A binary comparison starting at the beginning of the string. Returns "XXYXXPXXY".

MyString = Replace("XXpXXPXXp", "p", "Y",   ' A textual comparison starting at position 3. Returns "YXXYXXY". 3, -1, 1)

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Legal Notice.