IHoldsHandler.OnSetHold method

Processes the item when it is put on hold.

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

Syntax

'Declaration
Function OnSetHold ( _
    item As SPListItem, _
    hold As SPListItem _
) As HoldHandlerResult
'Usage
Dim instance As IHoldsHandler
Dim item As SPListItem
Dim hold As SPListItem
Dim returnValue As HoldHandlerResult

returnValue = instance.OnSetHold(item, _
    hold)

HoldHandlerResult OnSetHold(
    SPListItem item,
    SPListItem hold
)

Parameters

• item
  Type: Microsoft.SharePoint.SPListItem

  The item to process.

• hold
  Type: Microsoft.SharePoint.SPListItem

  The hold to put the item on.

Return value

Type: Microsoft.Office.RecordsManagement.Holds.HoldHandlerResult
The HoldHandlerResult to cancel, continue or skip default processing.

See also

Reference

IHoldsHandler interface

IHoldsHandler members

Microsoft.Office.RecordsManagement.Holds namespace