Share via

HoldSettings.IsOnHold method (String, DateTime)

  • Article

Checks whether the given URL is on hold and gets the last hold added date.

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 _
) As Boolean
'Usage
Dim instance As HoldSettings
Dim serverRelativeUrl As String
Dim lastHoldAddedDate As DateTime
Dim returnValue As Boolean

returnValue = instance.IsOnHold(serverRelativeUrl, _
    lastHoldAddedDate)

public bool IsOnHold(
    string serverRelativeUrl,
    out DateTime lastHoldAddedDate
)

Parameters

  • serverRelativeUrl
    Type: System.String

    server relative URL of a web

  • lastHoldAddedDate
    Type: System.DateTime

    the DateTime the last hold is added

Return value

Type: System.Boolean

See also

Reference

HoldSettings class

HoldSettings members

IsOnHold overload

Microsoft.Office.RecordsManagement.Preservation namespace