Ensures Method (Boolean)
Collapse the table of content
Expand the table of content

Contract.Ensures Method (Boolean)

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

Specifies a postcondition contract for the enclosing method or property.

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

'Declaration
<ConditionalAttribute("CONTRACTS_FULL")> _
Public Shared Sub Ensures ( _
	condition As Boolean _
)

Parameters

condition
Type: System.Boolean
The conditional expression to test. The expression may include OldValue(Of T), ValueAtReturn(Of T), and Result(Of T) values.

The condition parameter specifies a postcondition that is expected to be true when the enclosing method or property returns normally.

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

  • You must use the binary rewriter (available at Code Contracts on the MSDN DevLabs Web site) for run-time enforcement of this postcondition.

The following example shows how to use the Ensures method to ensure that an expected value is returned. This code example is part of a larger example provided for the ContractClassAttribute class.


Function Add(ByVal value As Object) As Integer Implements IArray.Add
    ' Returns the index in which an item was inserted.
    Contract.Ensures(Contract.Result(Of Integer)() >= -1) '
    Contract.Ensures(Contract.Result(Of Integer)() < CType(Me, IArray).Count) '
    Return 0

End Function 'IArray.Add


Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft