IWorkflow.StartWorkflow Method

SharePoint 2007

Starts a workflow instance on an item.

Namespace:  Microsoft.Office.Workflow
Assembly:  Microsoft.Office.WorkflowSoap (in Microsoft.Office.WorkflowSoap.dll)

string StartWorkflow(
	string item,
	Guid templateId,
	string workflowParameters


Type: System.String
The URL location of an item on which a workflow is being run.
Type: System.Guid
Globally unique identifier (GUID) of a workflow association.
Type: System.String
The initiation form data.

Return Value

Type: System.String
The return value contains no return specific data. It denotes the end of the transaction.

To complete the StartWorkflow method call, information about the available workflows for an item (provided by either the GetWorkflowDataForItem or GetTemplatesForItem method) is required.

The workflowParameters parameter value is passed as the eventData parameter string value to the StartWorkflow method. For more information, see Workflow Association and Initiation Forms (Windows SharePoint Services) in the Windows SharePoint Services 3.0 SDK.

The return value contains no specific data. The return value denotes the end of the transaction.

For examples of how to use the Workflow object model, see the Workflow code sample folder and EnterpriseContentManagementStarterKitSampleGuide document in the ECM Starter Kit folder in the Microsoft Office SharePoint Server 2007 SDK download.

Community Additions