Replace Method

Strings.Replace Method (String, String, String, Int32, Int32, CompareMethod)

 

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

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Public Shared Function Replace (
	Expression As String,
	Find As String,
	Replacement As String,
	Start As Integer,
	Count As Integer,
	Compare As CompareMethod
) As String

Parameters

Expression
Type: System.String

Required. String expression containing substring to replace.

Find
Type: System.String

Required. Substring being searched for.

Replacement
Type: System.String

Required. Replacement substring.

Start
Type: System.Int32

Optional. Position within Expression that starts a substring used for replacement. The return value of Replace is a string that begins at Start, with appropriate substitutions. If omitted, 1 is assumed.

Count
Type: System.Int32

Optional. Number of substring substitutions to perform. If omitted, the default value is –1, which means "make all possible substitutions."

Compare
Type: Microsoft.VisualBasic.CompareMethod

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

Return Value

Type: System.String

Replace returns the following values.

If

Replace returns

Find is zero-length or Nothing

Copy of Expression

Replace is zero-length

Copy of Expression with no occurrences of Find

Expression is zero-length or Nothing, or Start is greater than length of Expression

Nothing

Count is 0

Copy of Expression

Exception Condition
ArgumentException

Count < -1 or Start <= 0.

The return value of the Replace function is a string that begins at the position specified by Start and concludes at the end of the Expression string, with the substitutions made as specified by the Find and Replace values.

The Compare argument can have the following values.

Constant

Description

Binary

Performs a binary comparison

Text

Performs a textual comparison

This example demonstrates the Replace function.

Dim TestString As String = "Shopping List"
' Returns "Shipping List".
Dim aString As String = Replace(TestString, "o", "i")

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show:
© 2016 Microsoft