Méthode IVssBackupComponentsEx2 ::SetRestoreName (vsbackup.h)

Article
08/27/2023

Affecte un nouveau nom logique à un composant en cours de restauration.

Syntaxe

HRESULT SetRestoreName(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreName
);

Paramètres

[in] writerId

Identificateur global unique (GUID) de la classe writer.

[in] ct

Type du composant. Consultez l’énumération VSS_COMPONENT_TYPE pour connaître les valeurs possibles.

[in] wszLogicalPath

Chaîne de caractères larges terminée par null contenant le chemin logique du composant. Pour plus d’informations, consultez Chemin d’accès logique des composants.

La valeur de la chaîne contenant le chemin logique utilisé ici doit être identique à la chaîne utilisée lors de l’ajout du composant.

Le chemin logique peut être NULL.

Il n’existe aucune restriction sur les caractères qui peuvent apparaître dans un chemin logique non NULL .

[in] wszComponentName

Chaîne de caractères larges terminée par null contenant le nom du composant.

La chaîne ne peut pas être NULL et doit contenir le même nom de composant que celui utilisé lors de l’ajout du composant au jeu de sauvegarde à l’aide de la méthode IVssBackupComponents ::AddComponent .

[in] wszRestoreName

Chaîne de caractères larges terminée par null contenant le nom de restauration à définir pour le composant.

Valeur retournée

Voici les codes de retour valides pour cette méthode.

Valeur	Signification
S_OK	Le nom de restauration a été correctement défini.
E_INVALIDARG	L’une des valeurs de paramètre n’est pas valide.
E_OUTOFMEMORY	L’appelant n’a plus de mémoire ou d’autres ressources système.
VSS_E_BAD_STATE	Cette méthode n’a pas été appelée pendant une opération de restauration.
VSS_E_OBJECT_NOT_FOUND	Le composant spécifié est introuvable.
VSS_E_UNEXPECTED	Erreur inattendue. Le code d’erreur est enregistré dans le fichier journal des erreurs. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS. Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP : Cette valeur n’est pas prise en charge tant que Windows Server 2008 R2 et Windows 7. E_UNEXPECTED est utilisé à la place.

Remarques

La méthode SetRestoreName ne peut être appelée que pendant une opération de restauration.

Un writer indique qu’il prend en charge cette méthode en définissant l’indicateur VSS_BS_RESTORE_RENAME dans son masque de schéma de sauvegarde.

Pour plus d’informations, consultez Définition des options de restauration VSS.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	vsbackup.h (inclure VsBackup.h, Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

IVssBackupComponentsEx2

IVssComponentEx ::GetRestoreName

VSS_BACKUP_SCHEMA

Partager via