SPWorkItemJobDefinition.ProcessWorkItems Method (SPContentDatabase, SPWorkItemCollection, SPJobState)

Launches the processing of work items and specifies the content database, the work item collection that contains the work items, and the current state of the pausable timer jobs.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Protected Overridable Function ProcessWorkItems ( _
    contentDatabase As SPContentDatabase, _
    workItems As SPWorkItemCollection, _
    jobState As SPJobState _
) As Boolean
'Usage
Dim contentDatabase As SPContentDatabase
Dim workItems As SPWorkItemCollection
Dim jobState As SPJobState
Dim returnValue As Boolean

returnValue = Me.ProcessWorkItems(contentDatabase, _
    workItems, jobState)

protected virtual bool ProcessWorkItems(
    SPContentDatabase contentDatabase,
    SPWorkItemCollection workItems,
    SPJobState jobState
)

Parameters

• contentDatabase
  Type: Microsoft.SharePoint.Administration.SPContentDatabase

  The SPContentDatabase instance that contains the work item.

• workItems
  Type: Microsoft.SharePoint.SPWorkItemCollection

  The work item collection (SPWorkItemCollection instance) that contains the work item to process.

• jobState
  Type: Microsoft.SharePoint.Administration.SPJobState

  The current state of the pausable timer job as represented by the SPJobState instance.

Return Value

Type: System.Boolean
Returns Booleantrue if the timer job should continue processing the work item.

See Also

Reference

SPWorkItemJobDefinition Class

SPWorkItemJobDefinition Members

ProcessWorkItems Overload

Microsoft.SharePoint.Administration Namespace