次の方法で共有

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 以外のエラー コードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。

備考

キーに値がある場合は、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 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー winreg.h (Windows.h を含む)
ライブラリ Advapi32.lib
DLL Advapi32.dll

関連項目

RegDeleteKey を する

RegDeleteKeyEx

RegDeleteKeyTransacted の

レジストリ関数 を する