IVssBackupComponentsEx2：：SetRestoreName 方法 (vsbackup.h)

  • 發行項

將新的邏輯名稱指派給正在還原的元件。

語法

HRESULT SetRestoreName(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszRestoreName
);

參數

[in] writerId

寫入器類別的全域唯一標識碼 (GUID) 。

[in] ct

元件的類型。 如需可能的值 ，請參閱VSS_COMPONENT_TYPE 列舉。

[in] wszLogicalPath

以 Null 結尾的寬字元字串，其中包含元件的邏輯路徑。 如需詳細資訊，請參閱 元件的邏輯路徑。

包含此處所使用之邏輯路徑的字串值應該與新增元件時所使用的字串相同。

邏輯路徑可以是 NULL。

在非 NULL 邏輯路徑中出現的字元沒有任何限制。

[in] wszComponentName

包含元件名稱的 Null 終止寬字元字串。

字串不能是 NULL ，而且應該包含與元件新增至備份集時所使用的元件名稱相同的元件名稱，方法是使用 IVssBackupComponents：：AddComponent 方法。

[in] wszRestoreName

以 Null 結尾的寬字元字串，其中包含要為元件設定的還原名稱。

傳回值

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

值 意義
S_OK
 已成功設定還原名稱。
E_INVALIDARG
 其中一個參數值無效。
E_OUTOFMEMORY
 呼叫端記憶體不足或其他系統資源。
VSS_E_BAD_STATE
 還原作業期間未呼叫這個方法。
VSS_E_OBJECT_NOT_FOUND
 找不到指定的元件。
VSS_E_UNEXPECTED
 非預期的錯誤。 錯誤碼會記錄在錯誤記錄檔中。 如需詳細資訊，請參閱 VSS 下的事件和錯誤處理。

Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP： 在 Windows Server 2008 R2 和 Windows 7 之前，不支援此值。 改用E_UNEXPECTED。

備註

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

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

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

規格需求

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

另請參閱

IVssBackupComponentsEx2

IVssComponentEx：：GetRestoreName

VSS_BACKUP_SCHEMA