IPolicyFeature.ProcessListItemOnRemove Method

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

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

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, Microsoft Office SharePoint Server 2007 continues to process the remaining list items. If a policy feature returns false, Office SharePoint Server 2007 does not process the remaining items.

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

If the policy feature has not changed, Office SharePoint Server 2007 does not call any of its methods. This optimization prevents Office SharePoint Server 2007 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.

Community Additions

ADD
Show: