IVssComponent::SetBackupMetadata 方法 (vswriter.h)

SetBackupMetadata方法會使用 元件設定備份中繼資料。

寫入器只能在備份作業期間呼叫這個方法。

處理 BackupComplete (CVssWriter::OnBackupComplete) 或 BackupShutdown (CVssWriter::OnBackupShutdown) 事件時,無法呼叫此方法。

語法

HRESULT SetBackupMetadata(
  [in] LPCWSTR wszData
);

參數

[in] wszData

包含備份中繼資料的 Null終止寬字元字串。

傳回值

以下是這個方法的有效傳回碼。

意義
S_OK
成功設定專案。
E_INVALIDARG
其中一個參數值無效。
E_OUTOFMEMORY
呼叫端記憶體不足或其他系統資源。
VSS_E_OBJECT_ALREADY_EXISTS
已為此元件撰寫私人中繼資料。
VSS_E_BAD_STATE
這個方法不是由寫入器呼叫,或者,如果由寫入器呼叫,在備份作業期間或是在處理 BackupComplete 或 BackupShutdown 事件時呼叫此方法。

備註

SetBackupMetadata 會設定描述備份作業的私人寫入器特定中繼資料。

格式不需要符合任何 VSS 中繼資料規格。

規格需求

   
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限桌面應用程式]
目標平台 Windows
標頭 vswriter.h (包括 Vss.h、VsWriter.h)
程式庫 VssApi.lib

另請參閱

IVssComponent

IVssComponent::GetBackupMetadata

IVssComponent::SetRestoreMetadata