SPBackupRestoreSettings.GetRestoreSettings-Methode

Artikel
05/06/2015

Erstellt ein SPRestoreSettings -Objekt mit der angegebenen Quell- und -Methode und andere Werte auf ihre Standardwerte festgelegt.

Namespace: Microsoft.SharePoint.Administration.Backup
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Shared Function GetRestoreSettings ( _
    directory As String, _
    restoreMethod As String _
) As SPRestoreSettings
'Usage
Dim directory As String
Dim restoreMethod As String
Dim returnValue As SPRestoreSettings

returnValue = SPBackupRestoreSettings.GetRestoreSettings(directory, _
    restoreMethod)

public static SPRestoreSettings GetRestoreSettings(
    string directory,
    string restoreMethod
)

Parameter

directory
Typ: System.String

Das Verzeichnis, in dem die Quelle des Wiederherstellungsvorgangs; die der Sicherungskopie der wiederherzustellenden Objekte ist, wird gespeichert.

restoreMethod
Typ: System.String

Der Typ der Wiederherstellung, "New" oder "Überschreiben".

Rückgabewert

Typ: Microsoft.SharePoint.Administration.Backup.SPRestoreSettings
Ein SPRestoreSettings -Objekt mit allen Werten, die auf ihre Standardwerte festgelegt.

Hinweise

restoreMethod muss eine String Darstellung eines SPRestoreMethodType .

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie die GetRestoreSettings -Methode in einem Wiederherstellungsvorgang verwenden. Das vollständige Beispiel und eine ausführliche Erläuterung des es finden Sie unter How to: Programmatically Restore Content.

static void Main(string[] args)
{
    // Create the restore settings.
    SPRestoreSettings settings = SPBackupRestoreSettings.GetRestoreSettings(@"\\Server\WSSBackups", "Overwrite");

    // Identify the content component to restore.
    Console.Write("Enter name of component to restore (default is whole farm):");
    settings.IndividualItem = Console.ReadLine();
    
    // Set optional operation parameters.
    settings.IsVerbose = true;
    settings.UpdateProgress = 10;
    
    // Create the restore operation and return its ID.
    Guid restore = SPBackupRestoreConsole.CreateBackupRestore(settings);

    SPBackupRestoreObject node = EnsureUniqueValidComponentName(settings, ref restore);

    if (node != null)
    {
        // Set the restore as the active job and run it.
        if (SPBackupRestoreConsole.SetActive(restore) == true)
        {
            if (SPBackupRestoreConsole.Run(restore, node) == false)
            {
                // Report "error" through your UI.
                String error = SPBackupRestoreConsole.Get(restore).FailureMessage;
                Console.WriteLine(error);
            }
        }
        else
        {
            // Report through your UI that another backup
            // or restore operation is underway. 
            Console.WriteLine("Another backup or restore operation is already underway. Try again when it ends.");
        }

        // Clean up the operation.
        SPBackupRestoreConsole.Remove(restore);

        Console.WriteLine("Restore attempt complete. Press Enter to continue.");
        Console.ReadLine();
    }
}// end Main

Shared Sub Main(ByVal args() As String)
    ' Create the restore settings.
    Dim settings As SPRestoreSettings = SPBackupRestoreSettings.GetRestoreSettings("\\Server\WSSBackups", "Overwrite")

    ' Identify the content component to restore.
    Console.Write("Enter name of component to restore (default is whole farm):")
    settings.IndividualItem = Console.ReadLine()

    ' Set optional operation parameters.
    settings.IsVerbose = True
    settings.UpdateProgress = 10

    ' Create the restore operation and return its ID.
    Dim restore As Guid = SPBackupRestoreConsole.CreateBackupRestore(settings)

    Dim node As SPBackupRestoreObject = EnsureUniqueValidComponentName(settings, restore)

    If node IsNot Nothing Then
        ' Set the restore as the active job and run it.
        If SPBackupRestoreConsole.SetActive(restore) = True Then
            If SPBackupRestoreConsole.Run(restore, node) = False Then
                ' Report "error" through your UI.
                Dim [error] As String = SPBackupRestoreConsole.Get(restore).FailureMessage
                Console.WriteLine([error])
            End If
        Else
            ' Report through your UI that another backup
            ' or restore operation is underway. 
            Console.WriteLine("Another backup or restore operation is already underway. Try again when it ends.")
        End If

        ' Clean up the operation.
        SPBackupRestoreConsole.Remove(restore)

        Console.WriteLine("Restore attempt complete. Press Enter to continue.")
        Console.ReadLine()
    End If
End Sub ' end Main

Siehe auch

Referenz

SPBackupRestoreSettings Klasse

SPBackupRestoreSettings-Member

Microsoft.SharePoint.Administration.Backup-Namespace

Freigeben über