RegDeleteTreeW

指定したキーのサブキーと値を再帰的に削除する。(Unicode)

RegDeleteTreeW hKey, lpSubKey

hKey : [intptr] 開かれているレジストリキーへのハンドル。キーは次のアクセス権で開かれている必要がある: DELETE、KEY_ENUMERATE_SUB_KEYS、KEY_QUERY_VALUE。詳細はレジストリキーのセキュリティとアクセス権を参照のこと。このハンドルは RegCreateKeyEx、RegCreateKeyTransacted、RegOpenKeyEx、または RegOpenKeyTransacted 関数が返すか、以下の定義済みキーのいずれかを指定できる: HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS
lpSubKey : [wstr] キーの名前。このキーは hKey パラメータで識別されるキーのサブキーでなければならない。このパラメータが NULL の場合、hKey のサブキーと値が削除される。

(プラグイン / モジュール : advapi32.dll)

解説

指定したキーのサブキーと値を再帰的に削除する。(Unicode)

[戻り値]
関数が成功した場合、戻り値は ERROR_SUCCESS となる。関数が失敗した場合、戻り値は Winerror.h で定義された 0
以外のエラーコードとなる。FormatMessage 関数に FORMAT_MESSAGE_FROM_SYSTEM
フラグを指定して呼び出すと、エラーの一般的な説明を取得できる。

[備考]
キーに値がある場合、KEY_SET_VALUE で開かれていなければ、この関数は ERROR_ACCESS_DENIED
で失敗する。この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降に定義する。詳細は
Windows ヘッダの使用を参照のこと。
> [!NOTE] > 古いバージョンの Windows では、この API は kernel32.dll 経由でも公開されている。>
[!NOTE] > winreg.h ヘッダは RegDeleteTree をエイリアスとして定義しており、UNICODE
プリプロセッサ定数の定義に基づいて ANSI または Unicode
版を自動的に選択する。エンコーディングに中立なエイリアスをエンコーディング中立でないコードと混在させると、コンパイル時または実行時エラーとなる可能性がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照のこと。

情報