This documentation is archived and is not being maintained.

CorrelationDataMessageProperty Class

Provides a message property that accumulates additional correlation information for a message as protocols are applied, such as when data is returned from a MessageQuerySet over the incoming message.


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

public class CorrelationDataMessageProperty : IMessageProperty

The CorrelationDataMessageProperty type exposes the following members.

Public methodCorrelationDataMessagePropertyInitializes a new instance of the CorrelationDataMessageProperty class.

Public propertyStatic memberNameGets the name of this message property: “CorrelationDataMessageProperty”.

Public methodAddAdds a correlation data provider to the property’s private dictionary of providers.
Public methodStatic memberAddDataAdds correlation data to the specified message.
Public methodCreateCopyInitializes and returns a new CorrelationDataMessageProperty instance that is a copy of the current CorrelationDataMessageProperty instance.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves a correlation data provider from the private dictionary of data providers.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberTryGet(Message, CorrelationDataMessageProperty)Attempts to get a CorrelationDataMessageProperty from the specified message’s Properties.
Public methodStatic memberTryGet(MessageProperties, CorrelationDataMessageProperty)Attempts to get the CorrelationDataMessageProperty from the specified message properties.
Public methodTryGetValueAttempts to retrieve the specified correlation data provider from the private dictionary of data providers.

The correlation data accumulated by the CorrelationDataMessageProperty augments the message contents when calculating instance keys that relate messages to other messages.

.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.