Contract.Requires<'TException> Method (Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies a precondition contract for the enclosing method or property, and throws an exception if the condition for the contract fails.

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

static member Requires<'TException when 'TException : Exception> : 
        condition:bool -> unit

Parameters

condition
Type: System.Boolean

The conditional expression to test.

Type Parameters

TException

The exception to throw if the condition is false.

System_CAPS_importantImportant

You must turn on run-time checking to use the Requires<'TException> method. If run-time checking is turned off, the process will be terminated. To obtain the tools for runtime checking, see Code Contracts on the MSDN DevLabs Web site.

  • 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.

  • Use this method instead of the Contract.Requires(Boolean) method when you want to throw an exception if the precondition fails.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: