HoldSettings.IsOnHold method (String, DateTime, IList<HoldInfo>)

Checks whether the specified URL is on hold and gets the last hold added date with a list of applicable holds.

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

Syntax

'Declaration
Public Function IsOnHold ( _
    serverRelativeUrl As String, _
    <OutAttribute> ByRef lastHoldAddedDate As DateTime, _
    <OutAttribute> ByRef applicableHolds As IList(Of HoldInfo) _
) As Boolean
'Usage
Dim instance As HoldSettings
Dim serverRelativeUrl As String
Dim lastHoldAddedDate As DateTime
Dim applicableHolds As IList(Of HoldInfo)
Dim returnValue As Boolean

returnValue = instance.IsOnHold(serverRelativeUrl, _
    lastHoldAddedDate, applicableHolds)

public bool IsOnHold(
    string serverRelativeUrl,
    out DateTime lastHoldAddedDate,
    out IList<HoldInfo> applicableHolds
)

Parameters

• serverRelativeUrl
  Type: System.String

  Server relative URL of a web.

• lastHoldAddedDate
  Type: System.DateTime

  The DateTime the last hold is added.

• applicableHolds
  Type: System.Collections.Generic.IList<HoldInfo>

  List of applicable holds.

Return value

Type: System.Boolean

See also

Reference

HoldSettings class

HoldSettings members

IsOnHold overload

Microsoft.Office.RecordsManagement.Preservation namespace