IVssComponent：：GetBackupMetadata 方法 (vswriter.h)

GetBackupMetadata 方法會擷取 CVssWriter：：OnPrepareBackup 使用 IVssComponent：：SetBackupMetadata 在 PrepareForBackup 事件期間設定的私人寫入器特定備份元數據。

只有寫入器可以呼叫這個方法。

語法

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

[out] pbstrData

呼叫端配置的變數位址，接收包含 OnPrepareBackup 事件期間新增之備份元數據的字串。

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

值	意義
S_OK	已成功傳回屬性值。
S_FALSE	沒有與此元件相關聯的備份元數據。
E_INVALIDARG	其中一個參數值無效。
E_OUTOFMEMORY	呼叫端記憶體不足或其他系統資源。
VSS_E_INVALID_XML_DOCUMENT	XML 檔無效。請檢查事件記錄檔以取得詳細數據。如需詳細資訊，請參閱 VSS 下的事件和錯誤處理。

根據指定寫入器的邏輯，您可以隨時呼叫這個方法。

如果未設定任何備份元數據， GetBackupMetadata 會傳回S_FALSE。

如果 GetBackupMetadata 的呼叫成功，呼叫端會藉由呼叫 SysFreeString 函式來釋放 pbstrMetadata 參數中傳回的字串。