Contract.ValueAtReturn<T>(T) Method

Definition

Namespace:

System.Diagnostics.Contracts

Assembly:

System.Diagnostics.Contracts.dll

Source:

Contracts.cs

Represents the final (output) value of an out parameter when returning from a method.

public:
generic <typename T>
 static T ValueAtReturn([Runtime::InteropServices::Out] T % value);

public static T ValueAtReturn<T> (out T value);

static member ValueAtReturn : 'T -> 'T

Public Shared Function ValueAtReturn(Of T) (ByRef value As T) As T

Type Parameters

T

The type of the out parameter.

Parameters

value

T

The out parameter.

Returns

T

The output value of the out parameter.

Remarks

This method can be used only in the conditional expression for the Ensures contract. As with the OldValue method, you can omit the generic type parameter whenever the compiler is able to infer its type. The contract rewriter replaces the method call with the value of the out parameter. The ValueAtReturn method may appear only in postconditions. The argument to the method must be an out parameter or a field of a structure out parameter. The latter is also useful when referring to fields in the postcondition of a structure constructor.