RegDeleteTreeA 関数 (winreg.h)

  • [アーティクル]

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

構文

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

パラメーター

[in] hKey

開いているレジストリ キーへのハンドル。 キーは、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

[in, optional] lpSubKey

キーの名前です。 このキーは、 hKey パラメーターによって識別されるキーのサブキーである必要があります。 このパラメーターが NULL の場合、 hKey のサブキーと値は削除されます。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラー コードです。 FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage 関数を使用すると、エラーの一般的な説明を取得できます。

注釈

キーに値がある場合は、KEY_SET_VALUEで開く必要があります。または、この関数は ERROR_ACCESS_DENIED で失敗します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを 0x0600 以降として定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。

注意

従来のバージョンの Windows では、この API は kernel32.dll によっても公開されます。

注意

winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegDeleteTree を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winreg.h (Windows.h を含む)
Library Advapi32.lib
[DLL] Advapi32.dll

こちらもご覧ください

RegDeleteKey

RegDeleteKeyEx

RegDeleteKeyTransacted

レジストリ関数