RegRestoreKeyA 函式（winreg.h）

發行項
11/20/2024

讀取指定檔案中的登錄資訊，並將它複製到指定的機碼上。此登錄資訊的格式可能是機碼和多個子機碼層級。

備份或還原系統狀態的應用程式，包括系統檔案和登錄區，應該使用磁碟區陰影複製服務，而不是登錄功能。

語法

LSTATUS RegRestoreKeyA(
  [in] HKEY   hKey,
  [in] LPCSTR lpFile,
  [in] DWORD  dwFlags
);

參數

[in] hKey

開啟登錄機碼的句柄。此句柄是由 RegCreateKeyEx 或 RegOpenKeyEx 函式所傳回。它也可以是下列其中一個預先定義的索引鍵：

HKEY_CLASSES_ROOTHKEY_CURRENT_CONFIGHKEY_CURRENT_USERHKEY_LOCAL_MACHINEHKEY_USERS 此索引鍵及其子系索引鍵中包含的任何資訊，會由 lpFile 參數所指向之檔案中的資訊覆寫。

[in] lpFile

具有登錄信息的檔名。此檔案通常是使用 RegSaveKey 函式所建立。

[in] dwFlags

指出金鑰或金鑰還原方式的旗標。此參數可以是下列其中一個值。

價值	意義
REG_FORCE_RESTORE 0x00000008L	如果指定，即使開啟句柄存在於登錄階層中 hKey 參數指向的位置，仍會執行還原作業。
REG_WHOLE_HIVE_VOLATILE 0x000000001L	如果指定，則會建立新的揮發性（僅限記憶體）登錄資訊集或Hive。如果指定REG_WHOLE_HIVE_VOLATILE，hKey 參數所識別的索引鍵必須是 HKEY_USERS 或 HKEY_LOCAL_MACHINE 值。

傳回值

如果函式成功，則傳回值會ERROR_SUCCESS。

如果函式失敗，傳回值是 Winerror.h 中定義的非零錯誤碼。您可以使用 FormatMessage 函式搭配 FORMAT_MESSAGE_FROM_SYSTEM 旗標來取得錯誤的泛型描述。

言論

有兩種不同的登錄區檔格式。在目前操作系統上建立的登錄區通常無法由先前的登錄區載入。

如果開啟 hKey 參數的任何子機碼，RegRestoreKey 失敗。

呼叫進程必須具有登錄所在計算機上的SE_RESTORE_NAME和SE_BACKUP_NAME許可權。如需詳細資訊，請參閱以特殊許可權執行。

此函式會將指定索引鍵下方的索引鍵和值取代為檔案中最上層索引鍵的輔助索引鍵和值，不論檔案中最上層索引鍵的名稱為何。例如，hKey 可能會識別具有子機碼 B 和 C 的索引鍵 A，而 lpFile 參數則指定包含索引鍵 X 且子機碼為 Y 和 Z 的檔案。呼叫 RegRestoreKey之後，登錄會包含具有子機碼 Y 和 Z 的機碼 A。A 的值專案會取代為 X 的值專案。

lpFile 所指定檔案中的新資訊， 會覆寫 hKey 參數所指定的密鑰內容，但密鑰名稱除外。

如果 hKey 代表遠端電腦中的金鑰，lpFile 所描述的路徑會相對於遠端電腦。

注意

winreg.h 標頭會將 RegRestoreKey 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

要求

要求	價值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
支援的最低伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平臺	窗戶
標頭	winreg.h （包括 Windows.h）
連結庫	Advapi32.lib
DLL	Advapi32.dll