Hold.IsItemOnHold Method (SPListItem)

Returns a value that indicates if the item is on hold.

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

Syntax

'Declaration
Public Shared Function IsItemOnHold ( _
    item As SPListItem _
) As Boolean
'Usage
Dim item As SPListItem
Dim returnValue As Boolean

returnValue = Hold.IsItemOnHold(item)

public static bool IsItemOnHold(
    SPListItem item
)

Parameters

• item
  Type: Microsoft.SharePoint.SPListItem

  The document for which you want to determine if a hold has been applied.

Return Value

Type: System.Boolean
true if the specified document currently has a hold applied to it; otherwise, false.

Remarks

To determine if a document has a specific hold applied to it, use the IsItemOnHold method.

See Also

Reference

Hold Class

Hold Members

IsItemOnHold Overload

Microsoft.Office.RecordsManagement.Holds Namespace