Share via


WorkflowInteropService.StartWorkflow method

Starts a SharePoint SharePoint 2010 workflow from within your SharePoint 2013 workflow. For more information about implementing this method, see Use workflow interop for SharePoint 2013.

Namespace:  Microsoft.SharePoint.WorkflowServices
Assembly:  Microsoft.SharePoint.WorkflowServicesBase (in Microsoft.SharePoint.WorkflowServicesBase.dll)

Syntax

'Declaration
<ClientCallableMethodAttribute> _
Public MustOverride Function StartWorkflow ( _
    associationName As String, _
    correlationId As Guid, _
    listId As Guid, _
    itemGuid As Guid, _
    workflowParameters As IDictionary(Of String, Object) _
) As Guid
'Usage
Dim instance As WorkflowInteropService
Dim associationName As String
Dim correlationId As Guid
Dim listId As Guid
Dim itemGuid As Guid
Dim workflowParameters As IDictionary(Of String, Object)
Dim returnValue As Guid

returnValue = instance.StartWorkflow(associationName, _
    correlationId, listId, itemGuid, _
    workflowParameters)
[ClientCallableMethodAttribute]
public abstract Guid StartWorkflow(
    string associationName,
    Guid correlationId,
    Guid listId,
    Guid itemGuid,
    IDictionary<string, Object> workflowParameters
)

Parameters

  • associationName
    Type: System.String

    Association name of the SharePoint 2010 workflow to start.

  • correlationId
    Type: System.Guid

    Guid ID of the start request. This value is passed in the event message to uniquely identify the workflow.

  • listId
    Type: System.Guid

    ID of a list on which to enable workflow events; if a site workflow, pass Empty to ignore.

  • itemGuid
    Type: System.Guid

    ID of a list item on which to enable workflow events; if a site workflow, pass Empty to ignore.

Return value

Type: System.Guid
Returns the Guid ID of the workflow started.

See also

Reference

WorkflowInteropService class

WorkflowInteropService members

Microsoft.SharePoint.WorkflowServices namespace