SPBackupRestoreSettings.GetRestoreSettings - Méthode

Article
10/14/2015

Crée un objet SPRestoreSettings avec la source spécifiée et d'une méthode et d'autres valeurs définies à leurs valeurs par défaut.

Espace de noms : Microsoft.SharePoint.Administration.Backup
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Shared Function GetRestoreSettings ( _
    directory As String, _
    restoreMethod As String _
) As SPRestoreSettings
'Utilisation
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
)

Paramètres

directory
Type : System.String

Le répertoire dans lequel la source de l'opération de restauration ; qui est la copie de sauvegarde des objets en cours de restauration, est enregistré.

restoreMethod
Type : System.String

Le type de restauration, « New » ou « Écraser ».

Valeur renvoyée

Type : Microsoft.SharePoint.Administration.Backup.SPRestoreSettings
Un objet SPRestoreSettings avec toutes les valeurs définies à leurs valeurs par défaut.

Remarques

restoreMethod doit être une représentation sous forme de String d'une valeur de SPRestoreMethodType .

Exemples

L'exemple suivant montre comment utiliser la méthode GetRestoreSettings dans une opération de restauration. Pour l'exemple complet et une description détaillée de ce dernier, consultez 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

Voir aussi

Référence

SPBackupRestoreSettings classe

SPBackupRestoreSettings - Membres

Microsoft.SharePoint.Administration.Backup - Espace de noms

Partager via