structure VSS_COMPONENTINFO (vsbackup.h)

Article
03/06/2024

La structure VSS_COMPONENTINFO contient des informations sur un composant donné et est retournée aux demandeurs par l’interface IVssWMComponent .

Syntaxe

typedef struct _VSS_COMPONENTINFO {
  VSS_COMPONENT_TYPE type;
  BSTR               bstrLogicalPath;
  BSTR               bstrComponentName;
  BSTR               bstrCaption;
  BYTE               *pbIcon;
  UINT               cbIcon;
  bool               bRestoreMetadata;
  bool               bNotifyOnBackupComplete;
  bool               bSelectable;
  bool               bSelectableForRestore;
  DWORD              dwComponentFlags;
  UINT               cFileCount;
  UINT               cDatabases;
  UINT               cLogFiles;
  UINT               cDependencies;
} VSS_COMPONENTINFO;

Membres

type

Type de composant. Voir VSS_COMPONENT_TYPE.

bstrLogicalPath

Chaîne contenant le chemin logique du composant.

Un chemin logique peut être NULL.

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

bstrComponentName

Chaîne contenant le nom du composant. Une chaîne de nom de composant ne peut pas être NULL.

bstrCaption

Chaîne contenant la description du composant. Une chaîne légende peut avoir la valeur NULL.

pbIcon

Pointeur vers une mémoire tampon contenant les données binaires d’une icône pouvant être affichée représentant le composant. Le contenu de la mémoire tampon doit utiliser le même format que les fichiers d’icône standard (.ico). La taille, en octets, de la mémoire tampon est spécifiée par cbIcon.

Si l’enregistreur qui a créé le composant n’a pas choisi de spécifier une icône, pbIcon a la valeur NULL.

cbIcon

Taille, en octets, de l’icône affichable (pbIcon) représentant le composant. Si pbIcon a la valeur NULL, cbIcon doit être égal à zéro.

bRestoreMetadata

Boolean qui indique s’il existe des métadonnées privées associées à la restauration du composant. La valeur booléenne est true s’il existe des métadonnées et false si ce n’est pas le cas.

Un enregistreur indique si un composant prend en charge les métadonnées privées en définissant cette valeur lorsqu’un composant est ajouté avec IVssCreateWriterMetadata ::AddComponent. Les rédacteurs ajoutent ultérieurement des métadonnées de restauration avec IVssComponent ::SetRestoreMetadata. Les demandeurs récupèrent les informations à l’aide d’IVssComponent ::GetRestoreMetadata.

bNotifyOnBackupComplete

Réservé pour un usage futur. La valeur de ce paramètre doit toujours être définie sur false.

bSelectable

Boolean qui indique (pour les opérations en mode composant) si le composant peut être sélectionné pour la sauvegarde. La valeur de bSelectable permet de déterminer si un demandeur a la possibilité d’inclure ou d’exclure un composant donné dans les opérations de sauvegarde. Boolean est true si le composant est sélectionnable pour la sauvegarde et false s’il ne l’est pas.

Il n’existe aucune valeur par défaut pour la capacité de sélection d’un composant pour la sauvegarde. Un enregistreur doit toujours définir explicitement la valeur lorsqu’il ajoute le composant à son document de métadonnées writer à l’aide d’IVssCreateWriterMetadata ::AddComponent.

En outre, la valeur de bSelectable, le chemin logique du composant et la relation du composant avec d’autres composants, telles qu’elles sont exprimées dans ce chemin, déterminent quand et comment un composant est inclus dans une opération de sauvegarde :

Pour un composant non sélectionnable pour la sauvegarde (bSelectable est false) qui ne peut pas être sélectionné pour les ancêtres de sauvegarde dans la hiérarchie de son chemin logique, l’inclusion dans le jeu de sauvegarde est toujours obligatoire et toujours implicite. Un demandeur ajoute explicitement le composant au jeu de sauvegarde dans le document Composants de sauvegarde avec IVssBackupComponents ::AddComponent.
Pour un composant sélectionnable pour la sauvegarde (bSelectable est true) sans ancêtre de sauvegarde sélectionnable dans la hiérarchie de ses chemins logiques, l’inclusion dans le jeu de sauvegarde est toujours facultative et toujours explicite. Un demandeur ajoute explicitement le composant au jeu de sauvegarde dans le document Composants de sauvegarde avec IVssBackupComponents ::AddComponent.
Si un tel composant est inclus en tant qu’ancêtre dans le chemin logique d’autres composants, à la fois ceux qui peuvent être sélectionnés pour la sauvegarde et ceux qui ne le sont pas, il définit un ensemble de composants contenant ces autres composants en tant que sous-composants. Si un composant sélectionnable pour la sauvegarde est explicitement inclus dans une sauvegarde, ces sous-composants sont implicitement inclus dans la sauvegarde.
Pour un composant non sélectionnable pour la sauvegarde (bSelectable a la valeur false) qui a un ancêtre sélectionnable pour la sauvegarde dans la hiérarchie de ses chemins logiques (et fait donc partie d’un ensemble de composants défini par cet ancêtre), l’inclusion dans le jeu de sauvegarde est toujours implicite et conditionnelle à l’inclusion d’un ancêtre de sauvegarde sélectionnable pour la sauvegarde. Un demandeur n’ajoute jamais explicitement le composant au jeu de sauvegarde dans le document Composants de sauvegarde ; au lieu de cela, il ajoute l’ancêtre sélectionnable pour la sauvegarde au document à l’aide d’IVssBackupComponents ::AddComponent.
Pour un composant sélectionnable pour la sauvegarde (bSelectable a la valeur true) qui a un ancêtre sélectionnable pour la sauvegarde dans la hiérarchie de ses chemins logiques (et fait donc partie d’un ensemble de composants défini par cet ancêtre), l’inclusion dans le jeu de sauvegarde peut être facultative et explicite, ou si le composant n’est pas sélectionné explicitement, son inclusion peut être implicite et conditionnelle à l’inclusion d’un ancêtre de sauvegarde sélectionnable pour la sauvegarde. Si l’inclusion du composant est explicite, un demandeur ajoute explicitement les composants au jeu de sauvegarde dans le document Composants de sauvegarde avec IVssBackupComponents ::AddComponent.
Si l’inclusion est implicite, un demandeur n’ajoute pas ces composants à un jeu de sauvegarde dans le document Composants de sauvegarde.

Si l’inclusion du composant est explicite et que le composant définit un ensemble de composants, les membres de ce jeu de composants sont implicitement sélectionnés.

Un enregistreur définit la capacité de sélection d’un composant pour la sauvegarde (bSelectable) lors de l’ajout du composant au document de métadonnées writer à l’aide d’IVssCreateWriterMetadata ::AddComponent.

Pour plus d’informations , consultez Utilisation de la sélection et des chemins logiques .

bSelectableForRestore

Booléen qui indique (pour les opérations en mode composant) si le composant peut être sélectionné pour la restauration. bSelectableForRestore permet au demandeur de déterminer si ce composant peut être sélectionné individuellement pour la restauration s’il avait déjà été implicitement inclus dans la sauvegarde. Boolean est true si le composant est sélectionnable pour la restauration et false s’il ne l’est pas.

Par défaut, la capacité de sélection d’un composant pour la restauration est false. Un enregistreur peut remplacer cette valeur par défaut lorsqu’il ajoute le composant à son document de métadonnées writer à l’aide d’IVssCreateWriterMetadata ::AddComponent.

Si un composant est explicitement ajouté au document de sauvegarde (voir Inclusion de composant explicite), il peut toujours être sélectionné individuellement pour la restauration ; cet indicateur n’a donc aucune signification. Si un composant est implicitement ajouté au document de sauvegarde, l’indicateur bSelectableForRestore détermine si le composant peut être restauré individuellement à l’aide d’IVssBackupComponents ::AddRestoreSubcomponent.

Pour plus d’informations , consultez Utilisation de la sélection et des chemins logiques .

dwComponentFlags

Masque de bits (ou OR au niveau du bit) des valeurs de l’énumération VSS_COMPONENT_FLAGS , indiquant les fonctionnalités prises en charge par ce composant.

Windows Server 2003 et Windows XP : Avant Windows Server 2003 avec SP1, ce membre est réservé à l’utilisation du système.

cFileCount

Si le composant est un groupe de fichiers, nombre de descripteurs de fichiers pour les fichiers du groupe. Sinon, cette valeur est égale à zéro.

cDatabases

Si le composant est une base de données, le nombre de descripteurs de fichiers de base de données. Sinon, cette valeur est égale à zéro.

cLogFiles

Si le composant est une base de données, le nombre de descripteurs de fichier journal de base de données. Sinon, la valeur de ce paramètre est zéro.

cDependencies

Nombre de dépendances de composant d’écriture explicites du composant actuel. Cette valeur est incrémentée lorsque IVssCreateWriterMetadata ::AddComponentDependency est appelé par un enregistreur.

Remarques

Pour obtenir VSS_COMPONENTINFO objet pour un composant donné, un demandeur doit d’abord obtenir l’objet IVssWMComponent correspondant via un appel à IVssExamineWriterMetadata ::GetComponent. Un appel à IVssWMComponent ::GetComponentInfo alloue et retourne une structure VSS_COMPONENTINFO .

Étant donné que VSS_COMPONENTINFO est alloué et retourné par IVssWMComponent ::GetComponentInfo, un demandeur ne doit pas libérer un objet VSS_COMPONENTINFO directement, mais doit utiliser IVssWMComponent ::FreeComponentInfo.

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]
En-tête	vsbackup.h (inclure VsBackup.h, Vss.h, VsWriter.h)