Share via

Hold.GetApplicableHoldsLists Method

  • Article

Gets all of the applicable holds list accessible to the caller.

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

Syntax

'Declaration
Public Shared Function GetApplicableHoldsLists ( _
    web As SPWeb _
) As List(Of SPList)
'Usage
Dim web As SPWeb
Dim returnValue As List(Of SPList)

returnValue = Hold.GetApplicableHoldsLists(web)

public static List<SPList> GetApplicableHoldsLists(
    SPWeb web
)

Parameters

Return Value

Type: System.Collections.Generic.List<SPList>
All of the applicable holds lists that are accessible to the caller.

Remarks

The applicable holds lists are the holds lists that satisfy the following conditions: 1.The caller has view rights on the holds lists. 2. The holds lists are present in the "web" or any parent web of "web" including the site collections root web.

See Also

Reference

Hold Class

Hold Members

Microsoft.Office.RecordsManagement.Holds Namespace