This documentation is archived and is not being maintained.

CorrelationKey Class

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


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

public sealed class CorrelationKey : InstanceKey

The CorrelationKey type exposes the following members.

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

Public propertyIsValidGets a value that indicates whether the instance key is valid. (Inherited from InstanceKey.)
Public propertyKeyDataGets a dictionary of key data.
Public propertyKeyStringGets a String representation of the key data.
Public propertyMetadataGets the dictionary that contains metadata associated with the instance key. (Inherited from InstanceKey.)
Public propertyNameGets or sets the name of the CorrelationKey.
Public propertyProviderGets the provider.
Public propertyScopeNameGets the scope name.
Public propertyValueGets the GUID value associated with the current instance key. (Inherited from InstanceKey.)

Public methodEqualsCompares the GUID associated with the current object (stored in the Value property) with the GUID associated with the InstanceKey object. (Inherited from InstanceKey.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns a unique hash code for the current InstanceKey object’s GUID (stored in the Value property). (Inherited from InstanceKey.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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