RegexMatchTimeoutException Class

RegexMatchTimeoutException Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

The exception that is thrown when the execution time of a regular expression pattern-matching method exceeds its time-out interval.

System::Object
  System::Exception
    System::SystemException
      System::TimeoutException
        System.Text.RegularExpressions::RegexMatchTimeoutException

Namespace:  System.Text.RegularExpressions
Assembly:  System (in System.dll)

No code example is currently available or this language may not be supported.

The RegexMatchTimeoutException type exposes the following members.

  NameDescription
Public methodRegexMatchTimeoutException()Initializes a new instance of the RegexMatchTimeoutException class with a system-supplied message.
Public methodRegexMatchTimeoutException(String)Initializes a new instance of the RegexMatchTimeoutException class with the specified message string.
Public methodRegexMatchTimeoutException(String, Exception)Initializes a new instance of the RegexMatchTimeoutException class with a specified error message and a reference to the inner exception that is the cause of this exception.
Public methodRegexMatchTimeoutException(String, String, TimeSpan)Initializes a new instance of the RegexMatchTimeoutException class with information about the regular expression pattern, the input text, and the time-out interval.
Top

  NameDescription
Public propertyDataGets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public propertyHelpLinkGets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public propertyHResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public propertyInnerExceptionGets the Exception instance that caused the current exception. (Inherited from Exception.)
Public propertyInputGets the input text that the regular expression engine was processing when the time-out occurred.
Public propertyMatchTimeoutGets the time-out interval for a regular expression match.
Public propertyMessageGets a message that describes the current exception. (Inherited from Exception.)
Public propertyPatternGets the regular expression pattern that was used in the matching operation when the time-out occurred.
Public propertySourceGets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public propertyStackTraceGets a string representation of the frames on the call stack at the time the current exception was thrown. (Inherited from Exception.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the runtime type of the current instance. (Inherited from Exception.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringCreates and returns a string representation of the current exception. (Inherited from Exception.)
Top

The presence of a RegexMatchTimeoutException exception generally indicates one of the following conditions:

  • The regular expression engine is backtracking excessively as it attempts to match the input text to the regular expression pattern.

  • The time-out interval has been set too low, especially given high machine load.

The way in which an exception handler handles an exception depends on the cause of the exception:

  • If the time-out results from excessive backtracking, your exception handler should abandon the attempt to match the input and inform the user that a time-out has occurred in the regular expression pattern-matching method. If possible, information about the regular expression pattern, which is available from the Pattern property, and the input that caused excessive backtracking, which is available from the Input property, should be logged so that the issue can be investigated and the regular expression pattern modified. Time-outs due to excessive backtracking are always reproducible.

  • If the time-out results from setting the time-out threshold too low, you can increase the time-out interval and retry the matching operation. The current time-out interval is available from the MatchTimeout property. When a RegexMatchTimeoutException exception is thrown, the regular expression engine maintains its state so that any future invocations return the same result, as if the exception did not occur. The recommended pattern is to wait for a brief, random time interval after the exception is thrown before calling the matching method again. This can be repeated several times. However, the number of repetitions should be small in case the time-out is caused by excessive backtracking.

The example in the next section illustrates both techniques for handling a RegexMatchTimeoutException.

The following example illustrates two possible approaches to handling the RegexMatchTimeoutException exception. A constant whose value is two seconds defines the maximum time-out interval. The Regex::IsMatch(String, String, RegexOptions, TimeSpan) method is initially called with a time-out interval of one second. Each RegexMatchTimeoutException exception causes the time-out interval to be increased by one second and results in another call to the Regex::IsMatch method if the current time-out interval is less than the maximum time-out interval. However, if the current time-out interval exceeds the maximum time-out interval, the exception handler writes information to the event log and abandons the processing of the regular expression.

Windows Phone OS

Supported in: 8.1, 8.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2017 Microsoft