Edit

Share via


CorrelationKey Class

Definition

Represents an association between a piece of application data and an instance.

public ref class CorrelationKey sealed : System::Runtime::DurableInstancing::InstanceKey
public sealed class CorrelationKey : System.Runtime.DurableInstancing.InstanceKey
type CorrelationKey = class
    inherit InstanceKey
Public NotInheritable Class CorrelationKey
Inherits InstanceKey
Inheritance
CorrelationKey

Remarks

The key data is typically taken from a message that uses a set of queries contained in a MessageQuerySet. The CorrelationKey is then generated using a hash of the key data. Correlations are represented as a mapping between a CorrelationKey and an instance ID.

Constructors

CorrelationKey(IDictionary<String,String>, XName, XNamespace)

Initializes a new instance of the CorrelationKey class using the specified key data, scope name, and provider.

Properties

IsValid

Gets a value that indicates whether the instance key is valid.

(Inherited from InstanceKey)
KeyData

Gets a dictionary of key data.

KeyString

Gets a String representation of the key data.

Metadata

Gets the dictionary that contains metadata associated with the instance key.

(Inherited from InstanceKey)
Name

Gets or sets the name of the CorrelationKey.

Provider

Gets the provider.

ScopeName

Gets the scope name.

Value

Gets the GUID value associated with the current instance key.

(Inherited from InstanceKey)

Methods

Equals(Object)

Compares the GUID associated with the current object (stored in the Value property) with the GUID associated with the InstanceKey object.

(Inherited from InstanceKey)
GetHashCode()

Returns a unique hash code for the current InstanceKey object's GUID (stored in the Value property).

(Inherited from InstanceKey)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to