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

Article
08/27/2023

La méthode AddRestoreSubcomponent indique qu’un sous-composant membre d’un jeu de composants, qui avait été marqué comme non sélectionnable pour la sauvegarde, mais qui est marqué sélectionnable pour la restauration, doit être restauré, qu’un autre membre du jeu de composants soit restauré ou non.

Syntaxe

HRESULT AddRestoreSubcomponent(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE componentType,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszSubComponentLogicalPath,
  [in] LPCWSTR            wszSubComponentName,
  [in] bool               bRepair
);

Paramètres

[in] writerId

Identificateur de classe Writer.

[in] componentType

Identifie le type du composant. Reportez-vous à la documentation pour VSS_COMPONENT_TYPE pour connaître les valeurs de retour possibles.

[in] wszLogicalPath

Chaîne de caractères larges terminées par null contenant le chemin logique du composant dans le document de sauvegarde qui définit le jeu de composants de sauvegarde contenant le sous-composant à ajouter pour la restauration.

La valeur de ce paramètre peut être NULL.

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

[in] wszComponentName

La valeur de ce paramètre ne peut pas être NULL.

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

[in] wszSubComponentLogicalPath

Chaîne de caractères larges terminée par null contenant le chemin logique du sous-composant à ajouter pour la restauration.

Un chemin logique est requis lors de l’ajout d’un sous-composant. Par conséquent, la valeur de ce paramètre ne peut pas être NULL.

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

[in] wszSubComponentName

Chaîne de caractères larges terminée par null contenant le nom logique du sous-composant à ajouter pour la restauration.

La valeur de ce paramètre ne peut pas être NULL.

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

[in] bRepair

Ce paramètre est réservé à un usage futur. Ce paramètre doit toujours être défini sur false

Valeur retournée

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

Valeur	Signification
S_OK	Ajout réussi du sous-composant de restauration.
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 n’a pas é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_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_OBJECT_NOT_FOUND	Le composant n’existe pas.
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

Avant d’appeler AddRestoreSubcomponent, le composant racine défini par les paramètres wszLogicalPath et wszComponentName doit d’abord être sélectionné pour la restauration à l’aide d’IVssBackupComponents ::SetSelectedForRestore.

Si un demandeur doit prendre en charge la restauration des sous-composants, cette méthode doit être appelée avant IVssBackupComponents ::P reRestore.

AddRestoreSubcomponent est destiné au cas où tous les fichiers du jeu de composants d’un enregistreur doivent être sauvegardés en tant qu’unité, mais où il est souhaitable que les fichiers sélectionnés (sous-composants) puissent être restaurés individuellement.

Pour participer à une telle restauration, un sous-composant doit avoir le membre bSelectableForRestore de VSS_COMPONENTINFO défini sur TRUE. Le composant défini par les paramètres wszLogicalPath et wszComponentName doit également être sélectionné pour la restauration à l’aide d’IVssBackupComponents ::SetSelectedForRestore.

Pour plus d’informations, consultez Utilisation de la sélection pour la restauration et les sous-composants .

Configuration requise

Condition requise	Valeur
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