Share via


SPWorkItemStatus enumeration

Specifies the current processing status of an SPWorkItem object instance. The value is passed to the InternalState property.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

Syntax

'Declaration
<FlagsAttribute> _
Public Enumeration SPWorkItemStatus
'Usage
Dim instance As SPWorkItemStatus
[FlagsAttribute]
public enum SPWorkItemStatus

Members

Member name Description
None Indicates that processing of the SPWorkItem object has not started.
InProgress Indicates that processing of the SPWorkItem object is in progress.

When a SPWorkItemCollection object is fetched by using the SPRequest.GetRunnableWorkItemsAsSafeArray method, all work items that are returned have their InternalState property set to InProgress. This setting allows exclusive access to the work item by the client that owns it.

Completed Indicates that processing of the SPWorkItem object has been completed.

Typically, work items are deleted from the priority queue after they are processed. However, this option allows you to persist completed work items in the Completed state, such as when dependency or status reporting requirements require that the object remain in the queue.

All Indicates that processing of the SPWorkItem object is either in the InProgress state or the Completed state.

This value is a bitmask representing the logical OR or all possible flags for SPWorkItem.InternalState

See also

Reference

Microsoft.SharePoint namespace

InternalState