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.

System.Object
  System.Attribute
    System.Workflow.Activities.CorrelationParameterAttribute

Namespace:  System.Workflow.Activities
Assembly:  System.Workflow.Activities (in System.Workflow.Activities.dll)

'Declaration
<ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")> _
<AttributeUsageAttribute(AttributeTargets.Interface, AllowMultiple := True)> _
Public NotInheritable Class CorrelationParameterAttribute _
	Inherits Attribute

The CorrelationParameterAttribute type exposes the following members.

  NameDescription
Public methodCorrelationParameterAttributeInitializes a new instance of the CorrelationParameterAttribute where the name of the parameter is used for correlation.
Top

  NameDescription
Public propertyNameGets the name of the parameter used for correlation.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

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;
}

.NET Framework

Supported in: 4, 3.5, 3.0
Obsolete (compiler warning) in 4.6

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft