Regex::Replace Method (String, MatchEvaluator, Int32, Int32)
Within a specified input substring, replaces a specified maximum number of strings that match a regular expression pattern with a string returned by a MatchEvaluator delegate.
Assembly: System (in System.dll)
public: String^ Replace( String^ input, MatchEvaluator^ evaluator, int count, int startat )
Parameters
- input
- Type: System::String
The string to search for a match.
- evaluator
- Type: System.Text.RegularExpressions::MatchEvaluator
A custom method that examines each match and returns either the original matched string or a replacement string.
- count
- Type: System::Int32
The maximum number of times the replacement will occur.
- startat
- Type: System::Int32
The character position in the input string where the search begins.
Return Value
Type: System::StringA new string that is identical to the input string, except that a replacement string takes the place of each matched string.
| Exception | Condition |
|---|---|
| ArgumentNullException | input or evaluator is nullptr. |
| ArgumentOutOfRangeException | startat is less than zero or greater than the length of input. |
The Regex::Replace(String, MatchEvaluator, Int32, Int32) method is useful for replacing a regular expression match if any of the following conditions is true:
The replacement string cannot readily be specified by a regular expression replacement pattern.
The replacement string results from some processing done on the matched string.
The replacement string results from conditional processing.
The method is equivalent to calling the Regex::Matches(String, Int32) method and passing the first count Match objects in the returned MatchCollection collection to the evaluator delegate.
The regular expression is the pattern defined by the constructor for the current Regex object.
The evaluator parameter is the delegate for a custom method that you define and that examines each match. The custom method must have the following signature to match the MatchEvaluator delegate.
Your custom method returns a string that replaces the matched input.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.