SPBackupRestoreInformation.GenerateFileMapping - Méthode

Article
10/14/2015

Génère un nom unique pour le fichier de sauvegarde qui contient le fichier source spécifié.

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

Syntaxe

'Déclaration
Public Function GenerateFileMapping ( _
    name As String _
) As String
'Utilisation
Dim instance As SPBackupRestoreInformation
Dim name As String
Dim returnValue As String

returnValue = instance.GenerateFileMapping(name)

public string GenerateFileMapping(
    string name
)

Paramètres

name
Type : System.String

Le nom du fichier source.

Valeur renvoyée

Type : System.String
String qui représente le nom du fichier de sauvegarde contenant la sauvegarde copie de name.

Remarques

Cette méthode est utile si une opération de sauvegarde contient plusieurs fichiers portant le même nom. Pour vous assurer que chacune séparément la sauvegarde au lieu d'écraser mutuellement, cette méthode peut être utilisée pour générer un nom unique pour chacune. Elle est généralement appelée dans les implémentations de OnBackup(). Voir l'exemple ci-dessous.

Le format de la valeur de retour est .bak hex, où hex est un nombre hexadécimal à huit chiffres ; par exemple, "00000001.bak" ou 0000000A.bak".

Le paramètre name devient également une clé dans un magasin de paires clé-valeur, et la chaîne renvoyée par GenerateFileMapping devient la valeur de la clé. Cette paire est stockée dans le fichier spbackup.xml dans le dossier Location .

Notes

Bien que GenerateFileMapping et ReverseFileMapping renvoient exactement la même valeur en réponse à la même entrée, ils effectuent différentes choses en interne. GenerateFileMapping crée le nom de fichier unique et écrit la mappées paire de noms de fichiers dans le fichier spbackup.xml . ReverseFileMapping lit le mappage dans le fichier.

Exemples

L'exemple suivant montre la méthode GenerateFileMapping utilisée dans une implémentation de OnBackup(). Pour obtenir l'exemple complet, consultez How to: Create a Content Class That Can Be Backed Up and Restored.

public Boolean OnBackup(Object sender, SPBackupInformation args)
{
    if (args == null)
    {
    throw new ArgumentNullException("args");
    }

    Boolean successSignal = true;

    foreach (String path in FrontEndFilePaths)
    {
        FileInfo file = new FileInfo(path);
        try
        {
            String mappedFileName = args.GenerateFileMapping(file.Name);
            file.CopyTo(args.Location + @"\" + mappedFileName, true);
            args.Log(SPBackupRestoreLogSeverity.Verbose, "Backed up " + file.Name + " (in " + mappedFileName + ")");
        }
        catch (Exception e)
        {
            args.Log(SPBackupRestoreLogSeverity.Verbose, file.Name + " not backed up: " + e.Message);
            successSignal = false;
        }
    }

    args.CurrentProgress = 50;
    return successSignal;
}

Public Function OnBackup(ByVal sender As Object, ByVal args As SPBackupInformation) As Boolean
    If args Is Nothing Then
    Throw New ArgumentNullException("args")
    End If

    Dim successSignal As Boolean = True

    For Each path As String In FrontEndFilePaths
        Dim file As New FileInfo(path)
        Try
            Dim mappedFileName As String = args.GenerateFileMapping(file.Name)
            file.CopyTo(args.Location & "\" & mappedFileName, True)
            args.Log(SPBackupRestoreLogSeverity.Verbose, "Backed up " & file.Name & " (in " & mappedFileName & ")")
        Catch e As Exception
            args.Log(SPBackupRestoreLogSeverity.Verbose, file.Name & " not backed up: " & e.Message)
            successSignal = False
        End Try
    Next path

    args.CurrentProgress = 50
    Return successSignal
End Function

Voir aussi

Référence

SPBackupRestoreInformation classe

SPBackupRestoreInformation - Membres

Microsoft.SharePoint.Administration.Backup - Espace de noms

ReverseFileMapping

Partager via