IVssComponent::GetAlternateLocationMapping 方法 (vswriter.h)

GetAlternateLocationMapping 可用來傳回檔案集的替代位置以進行檔案還原。 這個方法可由寫入器或要求者呼叫。

語法

HRESULT GetAlternateLocationMapping(
  [in]  UINT           iMapping,
  [out] IVssWMFiledesc **ppFiledesc
);

參數

[in] iMapping

特定對應的索引。 此參數的值是包含 0 到 n–1 的整數,其中 n 是與目前元件相關聯的替代位置對應總數。 iVssComponent::GetAlternateLocationMappingCount 會傳回 n 的值。

[out] ppFiledesc

包含對應資訊的 IVssWMFiledesc 物件的雙間接指標。

傳回值

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

意義
S_OK
已成功傳回屬性值。
E_INVALIDARG
其中一個參數值無效。
E_OUTOFMEMORY
呼叫端記憶體不足或其他系統資源。
VSS_E_INVALID_XML_DOCUMENT
XML 檔無效。 請檢查事件記錄檔以取得詳細數據。 如需詳細資訊,請參閱 VSS 下的事件和錯誤處理
VSS_E_OBJECT_NOT_FOUND
找不到指定的專案。

備註

GetAlternateLocationMapping 傳回的替代位置對應不只來自目前元件中的檔案,也可以來自任何不可選取子元件中的檔案。

IVssComponent::GetAlternateLocationMapping 所傳回的值不應該與 IVssExternateWriterMetadata::GetAlternateLocationMapping 所傳回的值混淆:

如果下列任一項為 true,則檔案應一律還原至其替代位置對應:
  • ) 備份時間設定的還原 (方法VSS_RME_RESTORE_TO_ALTERNATE_LOCATION。
  • 其還原目標是在還原時間設定 (,) 設為 VSS_RT_ALTERNATE。
在任一情況下,未定義替代位置對應會構成寫入器錯誤。

如果下列任一項為 true,則可以將檔案還原至替代位置對應:

  • 還原方法VSS_RME_RESTORE_IF_NOT_THERE,而且磁碟上已經有檔案的版本。
  • 還原方法VSS_RME_RESTORE_IF_CAN_REPLACE,而且檔案的版本存在於磁碟上,而且無法取代。
替代位置對應只會在還原作業期間使用,不應與替代路徑混淆,這隻能在備份作業期間使用。

GetAlternateLocationMapping 所傳回的對應是指還原檔案時所使用的替代位置對應。

IVssBackupComponents::AddAlternativeLocationMapping 會將替代位置對應新增至 IVssComponent 物件。

呼叫端必須在使用指向的 IVssWMFiledesc 物件完成時,呼叫者呼叫 IUnknown::Release 來釋放 ppMapping 參數所持有的系統資源。

如需 VSS 下備份和還原檔位置的詳細資訊,請參閱 非預設備份和還原位置

規格需求

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

另請參閱

IVssBackupComponents::AddAlternativeLocationMapping

IVssComponent

IVssEx cloneWriterMetadata::GetAlternateLocationMapping