IPolicyFeature.ProcessListItemOnRemove method

Returns a Boolean value that specifies whether or not Microsoft SharePoint Server 2010 continues to process the remaining list items.

Namespace:  Microsoft.Office.RecordsManagement.InformationPolicy
Assembly:  Microsoft.Office.Policy (in Microsoft.Office.Policy.dll)

Syntax

'Declaration
Function ProcessListItemOnRemove ( _
    site As SPSite, _
    listItem As SPListItem _
) As Boolean
'Usage
Dim instance As IPolicyFeature
Dim site As SPSite
Dim listItem As SPListItem
Dim returnValue As Boolean

returnValue = instance.ProcessListItemOnRemove(site, _
    listItem)

bool ProcessListItemOnRemove(
    SPSite site,
    SPListItem listItem
)

Parameters

• site
  Type: Microsoft.SharePoint.SPSite

  The site collection to which the policy belongs.

• listItem
  Type: Microsoft.SharePoint.SPListItem

  The list item to which the policy no longer applies.

Return value

Type: System.Boolean
If a policy feature returns true, SharePoint Server 2010 continues to process the remaining list items. If a policy feature returns false, SharePoint Server 2010 does not process the remaining items.

Remarks

This method is called when a policy item is removed from a policy for all affected list items. SharePoint Server 2010 calls the ProcessListItem method on list items that are no longer subject to the specified policy item.

If the policy feature has not changed, SharePoint Server 2010 does not call any of its methods. This optimization prevents SharePoint Server 2010 from iterating through all the items on a list for policy features that are not involved with processing the item.

For more information, see IPolicyFeature Interface Overview and Policy Feature Definitions.

For an example of how to implement the IPolicyFeature interface, see the ProcessListItem method.

See also

Reference

IPolicyFeature interface

IPolicyFeature members

Microsoft.Office.RecordsManagement.InformationPolicy namespace