SPList.AddWorkflowAssociation Method
NOTE: This API is now obsolete.
Adds a workflow association to the list.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
<ObsoleteAttribute("Use WorkflowAssociations.Add() instead")> _
Public Function AddWorkflowAssociation ( _
workflowAssociation As SPWorkflowAssociation _
) As SPWorkflowAssociation
'Usage
Dim instance As SPList
Dim workflowAssociation As SPWorkflowAssociation
Dim returnValue As SPWorkflowAssociation
returnValue = instance.AddWorkflowAssociation(workflowAssociation)
[ObsoleteAttribute("Use WorkflowAssociations.Add() instead")]
public SPWorkflowAssociation AddWorkflowAssociation(
SPWorkflowAssociation workflowAssociation
)
Parameters
workflowAssociation
Type: Microsoft.SharePoint.Workflow.SPWorkflowAssociationAn SPWorkflowAssociation object that represents the workflow.
Return Value
Type: Microsoft.SharePoint.Workflow.SPWorkflowAssociation
The workflow association that was added.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | The argument passed to the workflowAssociation parameter is a null reference (Nothing in Visual Basic). |
ArgumentException | The IsDeclarative property on the workflow association is true, but user-defined workflows are not enabled for this Web application. For more information, see the UserDefinedWorkflowsEnabled property. The workflow association references a task list or a history list that is not on the same Web site as the list to which the workflow association is added. The workflow association is not valid—for example, if the Name property is a null reference (Nothing in Visual Basic). |