Hold.GetHolds Method

Gets the list of holds for the specified item.

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

Syntax

'Declaration
Public Shared Function GetHolds ( _
    item As SPListItem _
) As List(Of SPListItem)
'Usage
Dim item As SPListItem
Dim returnValue As List(Of SPListItem)

returnValue = Hold.GetHolds(item)

public static List<SPListItem> GetHolds(
    SPListItem item
)

Parameters

• item
  Type: Microsoft.SharePoint.SPListItem

  The item.

Return Value

Type: System.Collections.Generic.List<SPListItem>
The list holds for the specified item.

Remarks

This API returns a List of SPListItem objects where each SPListItem is a hold. The API will returns the holds that meet the following criteria: 1. The item is on at least one hold.2. The caller has view rights on the holds list to which the hold belongs.

See Also

Reference

Hold Class

Hold Members

Microsoft.Office.RecordsManagement.Holds Namespace