CorrelationCallbackMessageProperty.EndFinalizeCorrelation Method

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the message that was prepared asynchronously for correlation.

public:
 System::ServiceModel::Channels::Message ^ EndFinalizeCorrelation(IAsyncResult ^ result);

public System.ServiceModel.Channels.Message EndFinalizeCorrelation (IAsyncResult result);

member this.EndFinalizeCorrelation : IAsyncResult -> System.ServiceModel.Channels.Message

Public Function EndFinalizeCorrelation (result As IAsyncResult) As Message

Parameters

result: IAsyncResult

The IAsyncResult that references the asynchronous BeginFinalizeCorrelation(Message, TimeSpan, AsyncCallback, Object) operation.

Returns

Message

The message that was prepared for correlation.

Remarks

This method calls OnEndFinalizeCorrelation to retrieve the message. Applications must provide an implementation of OnEndFinalizeCorrelation, which returns the message that was prepared for correlation.

If EndFinalizeCorrelation is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation did not complete within the time-out interval specified in the call to BeginFinalizeCorrelation a TimeoutException is thrown when this method is called.

This method completes the asynchronous version of FinalizeCorrelation using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.

Applies to