IVssCreateExpressWriterMetadata::AddComponent, méthode (vswriter.h)

Article
08/27/2023

Ajoute un groupe de fichiers à l’ensemble de composants d’un writer express à sauvegarder.

Syntaxe

HRESULT AddComponent(
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszCaption,
  [in] const BYTE         *pbIcon,
  [in] UINT               cbIcon,
  [in] bool               bRestoreMetadata,
  [in] bool               bNotifyOnBackupComplete,
  [in] bool               bSelectable,
  [in] bool               bSelectableForRestore,
  [in] DWORD              dwComponentFlags
);

Paramètres

[in] ct

Valeur d’énumération VSS_COMPONENT_TYPE qui spécifie le type du composant. Seul VSS_CT_FILEGROUP est pris en charge pour ce paramètre.

[in] wszLogicalPath

Pointeur vers une chaîne de caractères larges terminée par null contenant le chemin logique de la base de données ou du groupe de fichiers. Pour plus d’informations, consultez Chemin d’accès logique des composants.

Ce paramètre est facultatif et peut être NULL.

[in] wszComponentName

Pointeur vers une chaîne de caractères larges terminée par null contenant le nom du composant. Cette chaîne n’est pas localisée.

Ce paramètre est obligatoire et ne peut pas être NULL. La chaîne ne peut pas contenir de barres obliques inverses.

[in] wszCaption

Pointeur vers une chaîne de caractères larges terminée par null contenant une description (également appelée « nom convivial ») pour le composant. Cette chaîne peut être localisée et, par conséquent, les demandeurs doivent supposer qu’elle est localisée.

Ce paramètre est facultatif et peut être NULL. La chaîne peut contenir des barres obliques inverses.

[in] pbIcon

Pointeur vers une bitmap de l’icône représentant la base de données, à afficher dans une interface utilisateur. La taille, en octets, de la mémoire tampon est spécifiée par le paramètre cbIcon .

Ce paramètre est facultatif et peut être NULL.

[in] cbIcon

Taille en octets de la mémoire tampon. Si le paramètre pbIcon a la valeur NULL, cbIcon doit être égal à zéro.

[in] bRestoreMetadata

Ce paramètre est réservé pour une utilisation ultérieure et doit toujours être défini sur false.

[in] bNotifyOnBackupComplete

Ce paramètre est réservé pour une utilisation ultérieure et doit toujours être défini sur false.

[in] bSelectable

Valeur booléenne qui indique si le composant peut être sauvegardé de manière facultative (ce qui signifie qu’il peut être exclu de la sauvegarde) ou est toujours sauvegardé lorsque l’un des composants de l’enregistreur est sauvegardé. Ce paramètre doit être défini sur
true si le composant peut être sauvegardé de manière sélective, ou false si le composant est sauvegardé lorsque l’un des composants est sauvegardé.

[in] bSelectableForRestore

Valeur booléenne qui détermine si un composant peut être restauré individuellement lorsqu’il n’a pas été explicitement inclus dans le document de sauvegarde. Si le composant a été explicitement ajouté au document de sauvegarde, il peut toujours être sélectionné individuellement pour la restauration ; dans ce cas, cet indicateur n’a aucune signification.

Lorsque ce paramètre a la valeur true, le composant peut être restauré par lui-même ; lorsque la valeur est false, le composant peut être restauré uniquement si l’ensemble de composants est en cours de restauration. (Pour plus d’informations, consultez VSS_COMPONENTINFO et Utilisation de la possibilité de sélection et des chemins logiques.)

La valeur par défaut de ce paramètre est false.

[in] dwComponentFlags

Masque de bits de VSS_COMPONENT_FLAGS valeurs d’énumération indiquant les fonctionnalités prises en charge par ce composant. Ce masque de bits ne peut pas inclure VSS_CF_APP_ROLLBACK_RECOVERY ni VSS_CF_BACKUP_RECOVERY.

La valeur par défaut de ce paramètre est zéro.

Valeur retournée

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

Valeur	Signification
S_OK	L'opération a réussi.
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_INVALID_XML_DOCUMENT	Le document XML n’est pas valide. Pour plus d’informations, consultez le journal des événements. Pour plus d’informations, consultez Gestion des événements et des erreurs sous VSS.
VSS_E_OBJECT_ALREADY_EXISTS	L’objet est un doublon. Un composant avec le même chemin logique et le même nom de composant existe déjà.
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 peut être appelée plusieurs fois pour ajouter plusieurs composants aux métadonnées d’un enregistreur express.

La combinaison de chemin d’accès logique et de nom pour chaque composant d’un instance spécifié d’une classe d’enregistreur spécifiée doit être unique. Une tentative d’appel de AddComponent deux fois avec les mêmes valeurs wszLogicalPath et wszComponentName génère une erreur VSS_E_OBJECT_ALREADY_EXISTS.

AddComponent peut être utilisé pour ajouter des sous-composants, des composants dans lesquels tous les fichiers membres sont sauvegardés en tant que groupe, mais qui contiennent des fichiers qui peuvent être restaurés individuellement. Pour plus d’informations, consultez Utilisation de la possibilité de sélection pour la restauration et les sous-composants.

Configuration requise


Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	vswriter.h (inclure Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

IVssCreateExpressWriterMetadata

Partager via