RaiseContractFailedEvent Method
Collapse the table of content
Expand the table of content

ContractHelper.RaiseContractFailedEvent Method

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

Used by the binary rewriter to activate the default failure behavior.

Namespace:  System.Runtime.CompilerServices
Assembly:  mscorlib (in mscorlib.dll)

public static string RaiseContractFailedEvent(
	ContractFailureKind failureKind,
	string userMessage,
	string conditionText,
	Exception innerException
)

Parameters

failureKind
Type: System.Diagnostics.Contracts.ContractFailureKind
One of the enumeration values that specifies the type of failure.
userMessage
Type: System.String
Additional user information.
conditionText
Type: System.String
The description of the condition that caused the failure.
innerException
Type: System.Exception
The inner exception that caused the current exception.

Return Value

Type: System.String
A null reference (Nothing in Visual Basic) if the event was handled and should not trigger a failure; otherwise, returns the localized failure message.

ExceptionCondition
ArgumentException

failureKind is not a valid ContractFailureKind value.

The binary rewriter calls this method to notify listeners about a contract failure. The RaiseContractFailedEvent(ContractFailureKind, String, String, Exception) method does not perform the failure behavior (an assert or throw) itself. If the failure is handled by the listeners, the method returns null. If the failure is not handled by the listeners, a localized failure message is returned.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft