Méthode IVssBackupComponents::SetRestoreOptions (vsbackup.h)

Article
08/27/2023

La méthode SetRestoreOptions définit une chaîne de paramètres de restauration privés ou dépendants de l’enregistreur pour un composant d’enregistreur.

Syntaxe

HRESULT SetRestoreOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreOptions
);

Paramètres

[in] writerId

Identificateur de l’enregistreur.

[in] ct

Type du composant. Consultez 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 la même que celle utilisée lorsque le composant a été ajouté au jeu de sauvegarde à l’aide d’IVssBackupComponents::AddComponent.

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 avoir la valeur NULL et doit contenir le même nom de composant que celui utilisé lorsque le composant a été ajouté au jeu de sauvegarde à l’aide d’IVssBackupComponents ::AddComponent.

[in] wszRestoreOptions

Chaîne de caractères larges terminée par null contenant la chaîne privée des paramètres de restauration. Pour plus d’informations, consultez Définition des options de restauration VSS.

Valeur retournée

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

Valeur	Signification
S_OK	Définissez correctement l’horodatage de sauvegarde précédent.
E_INVALIDARG	L’une des valeurs de paramètre n’est pas valide.
E_OUTOFMEMORY	L’appelant n’a pas de mémoire ou d’autres ressources système.
VSS_E_BAD_STATE	L’objet de composants de sauvegarde n’est pas initialisé, cette méthode a été appelée lors d’une opération de restauration ou cette méthode n’a pas été appelée dans la séquence correcte.
VSS_E_OBJECT_NOT_FOUND	Le composant de sauvegarde n’existe pas.
VSS_E_INVALID_XML_DOCUMENT	Le document XML n’est pas valide. Consultez le journal des événements pour plus d’informations. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
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

Cette méthode doit être appelée avant IVssBackupComponents::P reRestore.

La syntaxe et le contenu exacts des options de restauration définis par le paramètre wszRestoreOptions de la méthode SetRestoreOptions dépendent du rédacteur spécifique contacté.

Configuration requise


Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [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

IVssBackupComponents

IVssBackupComponents::P reRestore

VSS_COMPONENT_TYPE

Share via