SPWorkItem.InternalState Property
Instance value returned from the Microsoft.SharePoint.SPWorkItemStatus enumeration that specifies the current processing status of the work item.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
Public ReadOnly Property InternalState As SPWorkItemStatus
Get
'Usage
Dim instance As SPWorkItem
Dim value As SPWorkItemStatus
value = instance.InternalState
public SPWorkItemStatus InternalState { get; }
Property Value
Type: Microsoft.SharePoint.SPWorkItemStatus
Returns an enumeration value specifying the processing state of the work item object.
None |
Processing of the SPWorkItem object has not started. |
InProgress |
Processing of the SPWorkItem object is in progress. |
Completed |
Processing of the SPWorkItem object has been completed. |
All |
Processing of the SPWorkItem object is either in the InProgress state or the Completed state. |
Remarks
Typically, SPWorkItem objects are deleted from the priority queue after they are processed. However, your code can persist completed work items in the Completed state, when, for example, dependency or status reporting requirements, or other list synchronization issues, require that the object remain in the queue.
In cases in which the work item remains in the queue after its processing is completed, superfluous data that is stored in the TextPayload property should be removed.