CorrelationKey Class

.NET Framework (current version)
 

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

Namespace:   System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

System.Object
  System.Runtime.DurableInstancing.InstanceKey
    System.ServiceModel.Channels.CorrelationKey

public sealed class CorrelationKey : InstanceKey

NameDescription
System_CAPS_pubmethodCorrelationKey(IDictionary<String, String>, XName, XNamespace)

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

NameDescription
System_CAPS_pubpropertyIsValid

Gets a value that indicates whether the instance key is valid.(Inherited from InstanceKey.)

System_CAPS_pubpropertyKeyData

Gets a dictionary of key data.

System_CAPS_pubpropertyKeyString

Gets a String representation of the key data.

System_CAPS_pubpropertyMetadata

Gets the dictionary that contains metadata associated with the instance key.(Inherited from InstanceKey.)

System_CAPS_pubpropertyName

Gets or sets the name of the CorrelationKey.

System_CAPS_pubpropertyProvider

Gets the provider.

System_CAPS_pubpropertyScopeName

Gets the scope name.

System_CAPS_pubpropertyValue

Gets the GUID value associated with the current instance key. (Inherited from InstanceKey.)

NameDescription
System_CAPS_pubmethodEquals(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.)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

.NET Framework
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: