IVssComponentEx::GetRestoreName 方法 (vswriter.h)

取得指派給正在還原之元件的邏輯名稱。

語法

HRESULT GetRestoreName(
  [out] BSTR *pbstrName
);

參數

[out] pbstrName

呼叫端配置的變數位址,該變數會接收包含元件還原名稱的 Null 終止寬字元字串。

傳回值

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

意義
S_OK
作業成功。
E_INVALIDARG
其中一個參數值無效。
E_OUTOFMEMORY
呼叫端記憶體不足或其他系統資源。

備註

GetRestoreName方法只能在還原作業期間呼叫。

如果呼叫GetRestoreName成功,呼叫端會藉由呼叫SysFreeString函式,負責釋放pbstrName參數中傳回的字串。

寫入器會透過在備份架構遮罩中設定 VSS_BS_RESTORE_RENAME 旗標,指出它支援此方法。

如需詳細資訊,請參閱 設定 VSS 還原選項

規格需求

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

另請參閱

IVssBackupComponentsEx2::SetRestoreName

IVssComponentEx

VSS_BACKUP_SCHEMA