CorrelationHandle Class

Definition

Namespace:

System.ServiceModel.Activities

Assembly:

System.ServiceModel.Activities.dll

Associates activities together in a correlation by representing a particular shared InstanceKey or transient context in the workflow.

public ref class CorrelationHandle : System::Activities::Handle

[System.Runtime.Serialization.DataContract]
public class CorrelationHandle : System.Activities.Handle

[<System.Runtime.Serialization.DataContract>]
type CorrelationHandle = class
    inherit Handle

Public Class CorrelationHandle
Inherits Handle

Inheritance

Object

Handle

CorrelationHandle

Attributes

DataContractAttribute

Examples

The following example shows how to set the CorrelationHandle on a SendReply activity.

new SendReply
{
    DisplayName = "Send Adjusted Cost",
    Request = prescriptionRequest,
    // Initialize the orderHandle using the MessageQuerySet to correlate with the final GetAdjustedCost request
    CorrelationInitializers = 
    {
        new QueryCorrelationInitializer
        {
            CorrelationHandle = orderHandle,
            MessageQuerySet = GetOrderQuerySet
        }
    },
    Content = SendContent.Create(new InArgument<Order>((e) => order.Get(e)))
}

Remarks

Windows Workflow Foundation (WF) provides four types of correlation: Content Based, Request-Reply, Durable Duplex, and Context Exchange. For more information about correlation, see Correlation Overview, the specific correlation types mentioned previously, and the LINQ Message Query Correlation sample.

The runtime uses the CorrelationHandle for correlation if it is present, otherwise the CorrelatesWith property of the messaging activity will be used. If both are absent, the ambient handle provided by CorrelationScope or the workflow service is used.

Constructors

CorrelationHandle()

Initializes a new instance of the CorrelationHandle class.

Properties

ExecutionPropertyName	Gets the name to be used by this Handle when added to an activity's execution properties. (Inherited from Handle)
Owner	Gets the ActivityInstance that contains the Variable that contains the Handle. (Inherited from Handle)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnInitialize(HandleInitializationContext)	Registers the CorrelationHandle with the workflow runtime.
OnUninitialize(HandleInitializationContext)	Unregisters the CorrelationHandle with the workflow runtime.
ThrowIfUninitialized()	Throws an InvalidOperationException if the Handle has not been initialized. (Inherited from Handle)
ToString()	Returns a string that represents the current object. (Inherited from Object)