Share via


SPWorkItemJobDefinition.AutoDeleteWorkItemWhenException property

Gets a Boolean that specifies whether to automatically delete a work item (SPWorkItem object) from the processing queue when an exception occurs when attempting to process that work item.

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

Syntax

'Declaration
Public Overridable ReadOnly Property AutoDeleteWorkItemWhenException As Boolean
    Get
'Usage
Dim instance As SPWorkItemJobDefinition
Dim value As Boolean

value = instance.AutoDeleteWorkItemWhenException
public virtual bool AutoDeleteWorkItemWhenException { get; }

Property value

Type: System.Boolean
Returns true when automatically deleting work items when an exception occurs; otherwise, returns false. The default value is true.
Returns true if the default exception handler receives an unhandled exception and you want the respective event to be deleted automatically from the in-progress work items; otherwise, returns false. The default value is true.

See also

Reference

SPWorkItemJobDefinition class

SPWorkItemJobDefinition members

Microsoft.SharePoint.Administration namespace

SPWebService.ContentService

Microsoft.SharePoint.SPWorkItem