SPWorkItemCollection.RevertInProgressWorkItems method

Marks an in-process work item collection as not yet completed, but also not processed. Has the effect of returning the entire collection to an unprocessed state so it is picked up during a subsequent invocation of the RunnableWorkItems query.

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

Syntax

'Declaration
Public Function RevertInProgressWorkItems ( _
    processingMachineId As Guid, _
    parentId As Guid, _
    typeId As Guid, _
    batchId As Guid, _
    bRevertAll As Boolean _
) As Boolean
'Usage
Dim instance As SPWorkItemCollection
Dim processingMachineId As Guid
Dim parentId As Guid
Dim typeId As Guid
Dim batchId As Guid
Dim bRevertAll As Boolean
Dim returnValue As Boolean

returnValue = instance.RevertInProgressWorkItems(processingMachineId, _
    parentId, typeId, batchId, bRevertAll)
public bool RevertInProgressWorkItems(
    Guid processingMachineId,
    Guid parentId,
    Guid typeId,
    Guid batchId,
    bool bRevertAll
)

Parameters

  • processingMachineId
    Type: System.Guid

    Unique identifier (GUID) of the computer that is performing the proceessinge.

  • 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.

  • bRevertAll
    Type: System.Boolean

    Boolean specifying whether to revert all work items in the collection.

Return value

Type: System.Boolean
Returns a Boolean true if in-progress work items should be reverted to their pre-processing state; otherwise returns false.

See also

Reference

SPWorkItemCollection class

SPWorkItemCollection members

Microsoft.SharePoint namespace

SPWorkItemCollection.RevertInProgressWorkItem

SPWorkItemCollection.ParentId

SPWorkItem.BatchId

SPWorkItemCollection.WorkItemType