Site.RunUpgradeSiteSession method

  • Article

Either runs a site collection upgrade, or schedules it to be run in the future, depending on available system resources and the value of the queueOnly parameter.The user executing this method MUST be a farm administrator or a site collection administrator.

Namespace:  Microsoft.SharePoint.Client
Assembly:  Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)

Syntax

'Declaration
Public Sub RunUpgradeSiteSession ( _
    versionUpgrade As Boolean, _
    queueOnly As Boolean, _
    sendEmail As Boolean _
)
'Usage
Dim instance As Site
Dim versionUpgrade As Boolean
Dim queueOnly As Boolean
Dim sendEmail As Boolean

instance.RunUpgradeSiteSession(versionUpgrade, _
    queueOnly, sendEmail)

public void RunUpgradeSiteSession(
    bool versionUpgrade,
    bool queueOnly,
    bool sendEmail
)

Parameters

  • versionUpgrade
    Type: System.Boolean

    If true, specifies that a version-to-version upgrade will be performed. If false, specifies that a build-to-build upgrade will be performed.

  • queueOnly
    Type: System.Boolean

    If true, specifies that the upgrade will not be run immediately; it will be queued for a later run.

  • sendEmail
    Type: System.Boolean

    If true, a notification email will be sent to the requestor and the site collection administrators at the completion of the site collection upgrade. If false, such notification will not be sent.

See also

Reference

Site class

Site members

Microsoft.SharePoint.Client namespace