Metodo IVssCreateExpressWriterMetadata::AddComponent (vswriter.h)

Articolo
08/27/2023

Aggiunge un gruppo di file al set di componenti di un writer express da 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. Per questo parametro è supportato solo VSS_CT_FILEGROUP .

[in] wszLogicalPath

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

Questo parametro è 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 localizzato.

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 .

Questo parametro è facoltativo e può essere NULL.

[in] cbIcon

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

[in] bRestoreMetadata

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

[in] bNotifyOnBackupComplete

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

[in] bSelectable

Valore booleano che indica se il componente può essere eseguito facoltativamente il backup (ovvero può essere escluso dal backup) o viene sempre eseguito il backup quando uno dei componenti del writer viene eseguito il backup. Questo parametro deve essere impostato su
true se il componente può essere sottoposto a backup selettivo o false se il componente viene eseguito il backup quando uno dei componenti viene eseguito il backup.

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

Quando questo parametro è true, il componente può essere ripristinato da se stesso; quando false, il componente può essere ripristinato solo se l'intero set di componenti viene ripristinato. Per altre informazioni, vedere VSS_COMPONENTINFO e Utilizzo di percorsi selezionabili e logici.

Il valore predefinito per questo parametro è false.

[in] dwComponentFlags

Maschera di bit di valori di enumerazione VSS_COMPONENT_FLAGS che indica le funzionalità supportate da questo componente. Questa maschera di bit non può includere VSS_CF_APP_ROLLBACK_RECOVERY o VSS_CF_BACKUP_RECOVERY.

Il valore predefinito per questo parametro è 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 altre risorse di sistema.
VSS_E_INVALID_XML_DOCUMENT	Il documento XML non è valido. Controllare il registro eventi per informazioni dettagliate. 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 il 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 diversi componenti ai metadati di un writer express.

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

AddComponent può essere usato per aggiungere i sottocomponenti: componenti in cui tutti i file membro vengono sottoposti a backup come gruppo, ma che contengono file che possono essere ripristinati singolarmente. Per altre informazioni, vedere Uso della selezionabilità per il ripristino e i sottocomponenti.

Requisiti


Client minimo supportato	Windows 7 [solo app desktop]
Server minimo supportato	Windows Server 2008 R2 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	vswriter.h (include Vss.h, VsWriter.h)
Libreria	VssApi.lib

Vedi anche

IVssCreateExpressWriterMetadata

Condividi tramite