RegDeleteKeyExA 函式 (winreg.h)
從登錄的指定平臺特定檢視中刪除子機碼及其值。 請注意,索引鍵名稱不區分大小寫。
若要將子機碼刪除為交易作業,請呼叫 RegDeleteKeyTransacted 函式。
語法
LSTATUS RegDeleteKeyExA(
[in] HKEY hKey,
[in] LPCSTR lpSubKey,
[in] REGSAM samDesired,
DWORD Reserved
);
參數
[in] hKey
開啟登錄機碼的句柄。 此金鑰的訪問許可權不會影響刪除作業。 如需存取權限的詳細資訊,請參閱 登入機碼安全性和存取權限。
此句柄是由 RegCreateKeyEx 或 RegOpenKeyEx 函式傳回,或者它可以是下列其中一個 預先定義的索引鍵:
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_USERS
[in] lpSubKey
要刪除之金鑰的名稱。 此索引鍵必須是由 hKey 參數值所指定的索引鍵子機碼。
函式會以 DELETE 存取權開啟子機碼。
索引鍵名稱不區分大小寫。
這個參數的值不能 NULL。
[in] samDesired
存取遮罩 ,指定登錄的平臺特定檢視。
價值 | 意義 |
---|---|
|
從 32 位登錄檢視中刪除機碼。 |
|
從 64 位登錄檢視中刪除機碼。 |
Reserved
此參數是保留的,而且必須是零。
傳回值
如果函式成功,則傳回值會ERROR_SUCCESS。
如果函式失敗,傳回值是 Winerror.h 中定義的非零錯誤碼。 您可以使用 FormatMessage 函式搭配 FORMAT_MESSAGE_FROM_SYSTEM 旗標來取得錯誤的泛型描述。
言論
在關閉最後一個句柄之前,不會移除已刪除的索引鍵。
在 WOW64 上,32 位應用程式檢視與 64 位應用程式檢視之登錄樹狀目錄不同的登錄樹狀結構。 此函式可讓應用程式刪除替代登錄檢視中的專案。
要刪除的子機碼不得有子機碼。 若要刪除索引鍵及其所有子機碼,您需要列舉子機碼並個別刪除它們。 若要以遞歸方式刪除索引鍵,請使用 RegDeleteTree 或 SHDeleteKey 函式。
如果函式成功,RegDeleteKeyEx 從登錄中移除指定的機碼。 會移除整個索引鍵,包括其所有值。
注意
在舊版 Windows 上,此 API 也會由 kernel32.dll公開。
注意
winreg.h 標頭會根據 UNICODE 預處理器常數的定義,將 RegDeleteKeyEx 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows Vista、Windows XP Professional x64 Edition [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2008、Windows Server 2003 SP1 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | winreg.h (包括 Windows.h) |
連結庫 | Advapi32.lib |
DLL | Advapi32.dll |