Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Contract.EnsuresOnThrow<TException> Method (Boolean, String)

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

Specifies a postcondition contract and a message to display if the condition is false for the enclosing method or property, based on the provided exception and condition.

Namespace:  System.Diagnostics.Contracts
Assembly:  mscorlib (in mscorlib.dll)

[ConditionalAttribute("CONTRACTS_FULL")]
public static void EnsuresOnThrow<TException>(
	bool condition,
	string userMessage
)
where TException : Exception

Type Parameters

TException

The type of exception that invokes the postcondition check.

Parameters

condition
Type: System.Boolean
The conditional expression to test.
userMessage
Type: System.String
The message to display if the expression is false.

The condition parameter specifies a postcondition that is expected to be true when the enclosing method or property terminates abnormally and an exception of type TException is thrown. The message parameter specifies a message to display if the condition is false.

  • This method call must be at the beginning of a method or property, before any other code.

  • This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • You must use the binary rewriter for run-time enforcement of this postcondition.

  • If userMessage is not a constant string literal, the contract may not be understood by tools.

Windows Phone OS

Supported in: 8.1, 8.0

Show: