共用方式為


RegDeleteTreeA 函式 (winreg.h)

以遞歸方式刪除指定索引鍵的子機碼和值。

語法

LSTATUS RegDeleteTreeA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey
);

參數

[in] hKey

開啟登錄機碼的句柄。 密鑰必須以下列訪問許可權開啟:DELETE、KEY_ENUMERATE_SUB_KEYS和KEY_QUERY_VALUE。 如需詳細資訊,請參閱 登錄機碼安全性和訪問許可權

此句柄是由 RegCreateKeyExRegCreateKeyTransactedRegOpenKeyEx 或 RegOpenKeyTransacted 函式傳回,或者它可以是下列其中一個預先定義的密鑰

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in, optional] lpSubKey

索引鍵名稱。 此金鑰必須是 hKey 參數所識別金鑰的子 機碼 。 如果此參數為 NULL,則會刪除 hKey 的子機碼 和值。

傳回值

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

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

備註

如果索引鍵具有值,則必須以KEY_SET_VALUE開啟,否則此函式將會失敗並ERROR_ACCESS_DENIED。

若要編譯使用此函式的應用程式,請將_WIN32_WINNT定義為0x0600或更新版本。 如需詳細資訊,請參閱 使用 Windows 標頭

注意

在舊版 Windows 上,此 API 也會由 kernel32.dll 公開。

注意

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

規格需求

需求
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
目標平台 Windows
標頭 winreg.h (包含 Windows.h)
程式庫 Advapi32.lib
Dll Advapi32.dll

另請參閱

RegDeleteKey

RegDeleteKeyEx

RegDeleteKeyTransacted

登錄函式