WorkflowInstanceService.StartWorkflow method

Starts a Workflow Manager Client 1.0 instance specified by the subscription and passes the supplied parameters.

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

Syntax

'Declaration
<ClientCallableMethodAttribute> _
Public MustOverride Function StartWorkflow ( _
    subscription As WorkflowSubscription, _
    payload As IDictionary(Of String, Object) _
) As Guid
'Usage
Dim instance As WorkflowInstanceService
Dim subscription As WorkflowSubscription
Dim payload As IDictionary(Of String, Object)
Dim returnValue As Guid

returnValue = instance.StartWorkflow(subscription, _
    payload)

[ClientCallableMethodAttribute]
public abstract Guid StartWorkflow(
    WorkflowSubscription subscription,
    IDictionary<string, Object> payload
)

Parameters

• subscription
  Type: Microsoft.SharePoint.WorkflowServices.WorkflowSubscription

  The subscription associated with the workflow instance.

• payload
  Type: System.Collections.Generic.IDictionary<String, Object>

  IDictionary object that contains name-value pairs of parameter names and values to pass into the workflow instance.

Return value

Type: System.Guid
Returns the workflow instance to be started, with appropriate parameter values.

See also

Reference

WorkflowInstanceService class

WorkflowInstanceService members

Microsoft.SharePoint.WorkflowServices namespace