SPWorkItemCollection.CompleteInProgressWorkItems method

  • Article

Marks the list of in-progress work items as "complete" upon successfully processing the work item collection. Has the added effect of keeping the work items in the work item table, but in a state where they are not picked up by the GetRunnableWorkItems query.

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

Syntax

'Declaration
Public Sub CompleteInProgressWorkItems ( _
    parentId As Guid, _
    typeId As Guid, _
    batchId As Guid _
)
'Usage
Dim instance As SPWorkItemCollection
Dim parentId As Guid
Dim typeId As Guid
Dim batchId As Guid

instance.CompleteInProgressWorkItems(parentId, _
    typeId, batchId)

public void CompleteInProgressWorkItems(
    Guid parentId,
    Guid typeId,
    Guid batchId
)

Parameters

  • parentId
    Type: System.Guid

    Optional. Specifies the GUID of the parent entity of the work item collection, if any.

  • typeId
    Type: System.Guid

    Required. Specifies the work item type for work items in the collection.

  • batchId
    Type: System.Guid

    Optional. Specifies the GUID of the work item collection batch, if any.

Remarks

Use the optional parentId and batchId parameters to regulate the scope over which the method operates.

See also

Reference

SPWorkItemCollection class

SPWorkItemCollection members

Microsoft.SharePoint namespace

SPWorkItemCollection.DeleteInProgressWorkItems

SPWorkItemCollection.ParentId

SPWorkItem.BatchId

SPWorkItemCollection.WorkItemType