IWorkflow.GetWorkflowDataForItem Method

Gets the workflow data (tasks, associations, and workflows) for a specific user for a given SharePoint item.

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

Syntax

'Declaration
Function GetWorkflowDataForItem ( _
    item As String _
) As String
'Usage
Dim instance As IWorkflow
Dim item As String
Dim returnValue As String

returnValue = instance.GetWorkflowDataForItem(item)
string GetWorkflowDataForItem(
    string item
)

Parameters

  • item
    Type: System.String
    The URL location of an item which a workflow is being run on.

Return Value

Type: System.String
All the workflow information about the item. For example, the list of currently available workflow associations, the list of currently running workflows on the item, the list of tasks related to the workflow, and the list of default workflows for the item.

Remarks

You can specify the location of an item using its full URL, for example:

http://<server>/<customsite>/DocumentLibrary/example.docx

You can also use the full URL to a list to specify the location of an item, for example:

http://<server>/<customsite>/DocumentLibrary/

If you use the full URL to a list, only workflows explicitly associated with the list are returned. The instantiationURL attribute value is an empty string ("").

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.

See Also

Reference

IWorkflow Interface

IWorkflow Members

Microsoft.Office.Workflow Namespace