Méthode IVssCreateWriterMetadata ::AddComponent (vswriter.h)

Article
03/03/2024

La méthode AddComponent ajoute une base de données ou un groupe de fichiers en tant que composant à 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

Une valeur d’énumération VSS_COMPONENT_TYPE spécifiant le type du composant.

Windows Server 2003 et Windows XP : Avant Windows Server 2003 avec SP1, ce paramètre est réservé à l’utilisation du système et l’appelant ne doit pas remplacer la valeur par défaut.

[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.

Un chemin logique est facultatif et peut avoir la valeur 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 avoir la valeur 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. 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 .

Si l’enregistreur ne souhaite pas spécifier d’icône, pbIcon doit avoir la valeur 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é à une utilisation ultérieure et doit toujours être défini sur false.

[in] bNotifyOnBackupComplete

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

[in] bSelectable

Boolean 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é. La valeur Boolean est true si le composant peut être sauvegardé de manière sélective et false s’il est sauvegardé lorsque l’un des composants est sauvegardé.

[in] bSelectableForRestore

Boolean 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.

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

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

[in] dwComponentFlags

Un masque de bits (ou OR au niveau du bit) des membres du VSS_COMPONENT_FLAGS énumération indiquant les fonctionnalités prises en charge par ce composant.

La valeur par défaut de cet argument 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 pas de mémoire ou d’autres ressources système.
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_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.

La combinaison de chemin d’accès logique et de nom pour chaque composant d’un instance donné d’une classe d’enregistreur donnée doit être unique. La tentative d’appel de AddComponent deux fois avec les mêmes valeurs de wszLogicalPath et wszComponentName entraîne 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 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	vswriter.h (inclure Vss.h, VsWriter.h)
Bibliothèque	VssApi.lib

Voir aussi

IVssCreateWriterMetadata