Metodo IVssCreateWriterMetadata::AddComponent (vswriter.h)

Articolo
08/27/2023

Il metodo AddComponent aggiunge un database o un file group come componente di cui eseguire il backup.

Sintassi

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
);

Parametri

[in] ct

Valore di enumerazione VSS_COMPONENT_TYPE che specifica il tipo del componente.

Windows Server 2003 e Windows XP: Prima di Windows Server 2003 con SP1, questo parametro è riservato per l'uso del sistema e il chiamante non deve eseguire l'override del valore predefinito.

[in] wszLogicalPath

Puntatore a una stringa di caratteri wide con terminazione Null contenente il percorso logico del database o del file group. Per altre informazioni, vedere Percorso logico dei componenti.

Un percorso logico è facoltativo e può essere NULL.

[in] wszComponentName

Puntatore a una stringa di caratteri wide con terminazione Null contenente il nome del componente. Questa stringa non è localizzata.

Questo parametro è obbligatorio e non può essere NULL. La stringa non può contenere barre rovesciata.

[in] wszCaption

Puntatore a una stringa di caratteri wide con terminazione Null contenente una descrizione (denominata anche "nome descrittivo") per il componente. Questa stringa potrebbe essere localizzata e pertanto i richiedenti devono presupporre che sia localizzata.

Questo parametro è facoltativo e può essere NULL. La stringa può contenere barre rovesciata.

[in] pbIcon

Puntatore a una bitmap dell'icona che rappresenta il database da visualizzare in un'interfaccia utente. Le dimensioni, in byte, del buffer sono specificate dal parametro cbIcon .

Se il writer non vuole specificare un'icona, pbIcon deve essere impostato su NULL.

[in] cbIcon

Dimensione del buffer, in byte. Se il parametro pbIcon è NULL, cbIcon deve essere zero.

[in] bRestoreMetadata

Questo parametro è riservato per uso futuro e deve essere sempre impostato su false.

[in] bNotifyOnBackupComplete

Questo parametro è riservato per uso futuro e deve essere sempre impostato su false.

[in] bSelectable

Valore booleano che indica se è possibile eseguire il backup del componente facoltativamente (ovvero può essere escluso dal backup) o viene sempre eseguito il backup quando viene eseguito il backup di uno dei componenti del writer. Il valore booleano è true se è possibile eseguire il backup selettivo del componente e false se ne viene eseguito il backup quando viene eseguito il backup di uno dei componenti.

[in] bSelectableForRestore

Valore booleano che determina se un componente può essere ripristinato singolarmente quando non è stato incluso in modo esplicito nel documento di backup. Se il componente è stato aggiunto in modo esplicito al documento di backup, può essere sempre selezionato singolarmente per il ripristino; in questo caso, questo flag non ha alcun significato.

Se true, il componente può essere ripristinato da solo; se false, il componente può essere ripristinato solo se viene ripristinato l'intero set di componenti. Per altre informazioni, vedere VSS_COMPONENTINFO e Uso della selezione e dei percorsi logici .

Il valore predefinito per questo parametro è false.

[in] dwComponentFlags

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

Il valore predefinito per questo argomento è zero.

Valore restituito

Di seguito sono riportati i codici restituiti validi per questo metodo.

Valore	Significato
S_OK	L'operazione è stata completata.
E_INVALIDARG	Uno dei valori dei parametri non è valido.
E_OUTOFMEMORY	Il chiamante non è in memoria o in altre risorse di sistema.
VSS_E_INVALID_XML_DOCUMENT	Documento XML non valido. Per informazioni dettagliate, vedere il registro eventi. Per altre informazioni, vedere Gestione degli eventi e degli errori in VSS.
VSS_E_OBJECT_ALREADY_EXISTS	L'oggetto è un duplicato. Esiste già un componente con lo stesso percorso logico e lo stesso nome del componente.
VSS_E_UNEXPECTED	Errore imprevisto. Il codice di errore viene registrato nel file di log degli errori. Per altre informazioni, vedere Gestione degli eventi e degli errori in VSS. Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP: Questo valore non è supportato fino a Windows Server 2008 R2 e Windows 7. E_UNEXPECTED viene invece usato.

Commenti

Questo metodo può essere chiamato più volte per aggiungere più componenti ai metadati di un writer.

La combinazione di percorso logico e nome per ogni componente di una determinata istanza di una determinata classe di writer deve essere univoca. Il tentativo di chiamare AddComponent due volte con gli stessi valori di wszLogicalPath e wszComponentName genera un errore VSS_E_OBJECT_ALREADY_EXISTS.

AddComponent può essere usato per aggiungere sottocomponenti, ovvero componenti in cui viene eseguito il backup di tutti i file membro come gruppo, ma che contengono file che possono essere ripristinati singolarmente. Per altre informazioni, vedere Working with Selectability for Restore and Subcomponents .See Working with Selectability for Restore and Subcomponents for More information.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	vswriter.h (include Vss.h, VsWriter.h)
Libreria	VssApi.lib

Vedi anche

IVssCreateWriterMetadata