struttura VSS_COMPONENTINFO (vsbackup.h)

Articolo
08/27/2023

La struttura VSS_COMPONENTINFO contiene informazioni su un determinato componente e viene restituito ai richiedenti dall'interfaccia IVssWMComponent .

Sintassi

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;

Members

type

Tipo di componente. Vedere VSS_COMPONENT_TYPE.

bstrLogicalPath

Stringa contenente il percorso logico del componente.

Un percorso logico può essere NULL.

Non esistono restrizioni sui caratteri che possono essere visualizzati in un percorso logico non NULL .

bstrComponentName

Stringa che contiene il nome del componente. Una stringa del nome del componente non può essere NULL.

bstrCaption

Stringa contenente la descrizione del componente. Una stringa didascalia può essere NULL.

pbIcon

Puntatore a un buffer contenente i dati binari per un'icona visualizzabile che rappresenta il componente. Il contenuto del buffer deve usare lo stesso formato dei file dell'icona standard (.ico). Le dimensioni, in byte, del buffer sono specificate da cbIcon.

Se il writer che ha creato il componente non ha scelto di specificare un'icona, pbIcon è NULL.

cbIcon

Dimensioni, in byte, dell'icona visualizzabile (pbIcon) che rappresenta il componente. Se pbIcon è NULL, cbIcon deve essere zero.

bRestoreMetadata

Boolean che indica se sono presenti metadati privati associati al ripristino del componente. Il valore booleano è true se sono presenti metadati e false se non è presente.

Un writer indica se un componente supporta i metadati privati impostando questo valore quando viene aggiunto un componente con IVssCreateWriterMetadata::AddComponent. I writer aggiungono in seguito metadati di ripristino con IVssComponent::SetRestoreMetadata. I richiedenti recuperano le informazioni usando IVssComponent::GetRestoreMetadata.

bNotifyOnBackupComplete

Riservato per utilizzi futuri. Il valore di questo parametro deve essere sempre impostato su false.

bSelectable

Boolean che indica (per le operazioni in modalità componente) se il componente è selezionabile per il backup. Il valore di bSelectable consente di determinare se un richiedente ha l'opzione di includere o escludere un determinato componente nelle operazioni di backup. Il valore booleano è true se il componente è selezionabile per il backup e false se non è.

Non esiste alcun valore predefinito per la selezionabilità di un componente per il backup. Un writer deve sempre impostare in modo esplicito il valore quando aggiunge il componente al documento metadati writer usando IVssCreateWriterMetadata::AddComponent.

Inoltre, il valore di bSelectable, il percorso logico del componente e la relazione del componente ad altri componenti, come espresso in tale percorso, determinano quando e come un componente è incluso in un'operazione di backup:

Per un componente non selezionabile per il componente di backup (bSelectable è false) senza selezione per i predecessori di backup nella gerarchia del percorso logico, l'inclusione nel set di backup è sempre obbligatoria e sempre implicita. Un richiedente aggiunge in modo esplicito il componente al set di backup nel documento Componenti di backup con IVssBackupComponents::AddComponent.
Per un componente selezionabile per il backup (bSelectable è true) senza selezionare il predecessore del backup nella gerarchia dei percorsi logici, l'inclusione nel set di backup è sempre facoltativa e sempre esplicita. Un richiedente aggiunge in modo esplicito il componente al set di backup nel documento Componenti di backup con IVssBackupComponents::AddComponent.
Se tale componente è incluso come predecessore nel percorso logico di altri componenti, entrambi quelli selezionabili per il backup e quelli che non sono, definisce un set di componenti contenente questi altri componenti come sottocomponenti. Se un componente selezionabile per il backup è incluso in modo esplicito in un backup, questi sottocomponenti vengono inclusi in modo implicito nel backup.
Per un componente non selezionabile per il componente di backup (bSelectable è false) che dispone di un predecessore selezionabile per il backup nella gerarchia dei percorsi logici (e quindi fanno parte di un set di componenti definito da tale predecessore), l'inclusione nel set di backup è sempre implicita e condizionale sull'inclusione di un predecessore selezionabile per il backup predecessore. Un richiedente non aggiunge mai in modo esplicito il componente al set di backup nel documento Componenti di backup; aggiunge invece il valore selezionabile per il predecessore del backup al documento usando IVssBackupComponents::AddComponent.
Per un componente selezionabile per il componente di backup (bSelectable è true) che dispone di un predecessore selezionabile per il backup nella gerarchia dei percorsi logici (ed è quindi parte di un set di componenti definito da tale predecessore), l'inclusione nel set di backup può essere facoltativa ed esplicita oppure se il componente non è selezionato in modo esplicito, l'inclusione può essere implicita e vincolata all'inclusione di un predecessore selezionabile per il backup. Se l'inclusione del componente è esplicita, un richiedente aggiunge in modo esplicito i componenti al set di backup nel documento Componenti di backup con IVssBackupComponents::AddComponent.
Se l'inclusione è implicita, un richiedente non aggiunge questi componenti a un set di backup nel documento Componenti di backup.

Se l'inclusione del componente è esplicita e il componente definisce un set di componenti, i membri del set di componenti vengono selezionati in modo implicito.

Un writer imposta la selezionabilità di un componente per il backup (bSelectable) quando si aggiunge il componente al documento metadati writer usando IVssCreateWriterMetadata::AddComponent.

Per altre informazioni, vedere Uso di percorsi selezionabili e logici .

bSelectableForRestore

Boolean che indica (per le operazioni in modalità componente) se il componente è selezionabile per il ripristino. bSelectableForRestore consente al richiedente di determinare se questo componente può essere selezionato singolarmente per il ripristino se è stato incluso in precedenza in modo implicito nel backup. Il valore booleano è true se il componente è selezionabile per il ripristino e false se non è.

Per impostazione predefinita, la selezionabilità di un componente per il ripristino è false. Un writer può eseguire l'override di questo valore predefinito quando aggiunge il componente al documento metadati writer usando IVssCreateWriterMetadata::AddComponent.

Se un componente viene aggiunto in modo esplicito al documento di backup (vedere l'inclusione esplicita del componente), può essere sempre selezionato singolarmente per il ripristino; quindi questo flag non ha alcun significato. Se un componente viene aggiunto implicitamente al documento di backup, il flag bSelectableForRestore determina se il componente può essere ripristinato singolarmente usando IVssBackupComponents::AddRestoreSubcomponent.

Per altre informazioni, vedere Uso di percorsi selezionabili e logici .

dwComponentFlags

Maschera bit (o OR bit per bit) dei valori dell'enumerazione VSS_COMPONENT_FLAGS , che indica le funzionalità supportate da questo componente.

Windows Server 2003 e Windows XP: Prima di Windows Server 2003 con SP1, questo membro è riservato per l'uso del sistema.

cFileCount

Se il componente è un gruppo di file, il numero di descrittori di file per i file nel gruppo. In caso contrario, questo valore è zero.

cDatabases

Se il componente è un database, il numero di descrittori di file di database. In caso contrario, questo valore è zero.

cLogFiles

Se il componente è un database, il numero di descrittori del file di log del database. In caso contrario, il valore di questo parametro è zero.

cDependencies

Numero di dipendenze esplicite del componente writer esplicito del componente corrente. Questo valore viene incrementato quando IVssCreateWriterMetadata::AddComponentDependency viene chiamato da un writer.

Commenti

Per ottenere VSS_COMPONENTINFO oggetto per un determinato componente, un richiedente deve prima ottenere l'oggetto IVssWMComponent corrispondente tramite una chiamata a IVssExamineWriterMetadata::GetComponent. Una chiamata a IVssWMComponent::GetComponentInfo alloca e restituisce una struttura VSS_COMPONENTINFO .

Poiché VSS_COMPONENTINFO viene allocata e restituita da IVssWMComponent::GetComponentInfo, un richiedente non deve liberare direttamente un oggetto VSS_COMPONENTINFO , ma deve usare IVssWMComponent::FreeComponentInfo.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Intestazione	vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h)