Workflow.StartWorkflow Method
Starts a workflow instance on an item.
Namespace: Microsoft.Office.Workflow
Assembly: Microsoft.Office.WorkflowSoap (in Microsoft.Office.WorkflowSoap.dll)
Syntax
'Declaration
<WebMethodAttribute> _
Public Function StartWorkflow ( _
item As String, _
templateId As Guid, _
workflowParameters As SoapXml.SoapXmlElement _
) As SoapXml.SoapXmlElement
'Usage
Dim instance As Workflow
Dim item As String
Dim templateId As Guid
Dim workflowParameters As SoapXml.SoapXmlElement
Dim returnValue As SoapXml.SoapXmlElement
returnValue = instance.StartWorkflow(item, _
templateId, workflowParameters)
[WebMethodAttribute]
public SoapXml.SoapXmlElement StartWorkflow(
string item,
Guid templateId,
SoapXml.SoapXmlElement workflowParameters
)
Parameters
- item
Type: System.String
The URL location of an item on which a workflow is being run.
- templateId
Type: System.Guid
Globally unique identifier (GUID) of a workflow association.
- workflowParameters
Type: Microsoft.SharePoint.SoapServer.SoapXml.SoapXmlElement
The initiation form data.
Return Value
Type: Microsoft.SharePoint.SoapServer.SoapXml.SoapXmlElement
The SoapXml.SoapXmlElement object.
Implements
ISoapServerWorkflow.StartWorkflow(String, Guid, SoapXml.SoapXmlElement)
Remarks
To complete the StartWorkflow call, information about the available workflows, provided by either the GetWorkflowDataForItem or GetTemplatesForItem methods for an item 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.