.NET Framework Class Library
CorrelationParameterAttribute Class

Note: This API is now obsolete.

Indicates the name of the parameter used for correlation in the methods and events defined on an ExternalDataExchange interface. This class cannot be inherited.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Workflow.ActivitiesCorrelationParameterAttribute

Namespace:   System.Workflow.Activities
Assembly:  System.Workflow.Activities (in System.Workflow.Activities.dll)
Syntax
<[%$TOPIC/ms608756_en-us_VS_110_2_0_0_0_0%]("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")> _
<[%$TOPIC/ms608756_en-us_VS_110_2_0_0_0_1%]([%$TOPIC/ms608756_en-us_VS_110_2_0_0_0_2%].Interface, AllowMultiple := True)> _
Public NotInheritable Class CorrelationParameterAttribute _
	Inherits [%$TOPIC/ms608756_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/ms608756_en-us_VS_110_2_0_1_0_0%]("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
[[%$TOPIC/ms608756_en-us_VS_110_2_0_1_0_1%]([%$TOPIC/ms608756_en-us_VS_110_2_0_1_0_2%].Interface, AllowMultiple = true)]
public sealed class CorrelationParameterAttribute : [%$TOPIC/ms608756_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/ms608756_en-us_VS_110_2_0_2_0_0%](L"The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
[[%$TOPIC/ms608756_en-us_VS_110_2_0_2_0_1%]([%$TOPIC/ms608756_en-us_VS_110_2_0_2_0_2%]::Interface, AllowMultiple = true)]
public ref class CorrelationParameterAttribute sealed : public [%$TOPIC/ms608756_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/ms608756_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms608756_en-us_VS_110_2_0_3_0_1%]("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
[<[%$TOPIC/ms608756_en-us_VS_110_2_0_3_0_2%]([%$TOPIC/ms608756_en-us_VS_110_2_0_3_0_3%].Interface, AllowMultiple = true)>]
type CorrelationParameterAttribute =  
    class 
        inherit [%$TOPIC/ms608756_en-us_VS_110_2_0_3_0_4%] 
    end

The CorrelationParameterAttribute type exposes the following members.

Constructors
  NameDescription
Public method CorrelationParameterAttributeInitializes a new instance of the CorrelationParameterAttribute where the name of the parameter is used for correlation.
Top
Properties
  NameDescription
Public property NameGets the name of the parameter used for correlation.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks
NoteNote

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

Default setting; can be overridden by the CorrelationAliasAttribute.

Examples

The following code example demonstrates how to use a CorrelationParameterAttribute for an EnternalDataExchange interface. This code example is from the CorrelatedLocalService SDK sample. For more information, see Correlated Local Service Sample.

[ExternalDataExchange]
[CorrelationParameter("taskId")]
public interface ITaskService
{
    [CorrelationInitializer]
    void CreateTask(string taskId, string assignee, string text);

    [CorrelationAlias("taskId", "e.Id")]
    event EventHandler<TaskEventArgs> TaskCompleted;
}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0
Obsolete (compiler warning) in 4.6
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5.2
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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