This topic has not yet been rated - Rate this topic

Contract.Requires<TException> Method (Boolean)

.NET Framework 4.5

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)

Syntax

C++

public static void Requires<TException>(
	bool condition
)
where TException : Exception

Type Parameters

TException: The exception to throw if the condition is false.

Parameters

condition: Type: System.Boolean
The conditional expression to test.

Remarks

Important
You must turn on run-time checking to use the Requires 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.

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Contract Class

Requires Overload

System.Diagnostics.Contracts Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)