RegDeleteKeyTransactedA 関数 (winreg.h)
トランザクション操作として、レジストリの指定されたプラットフォーム固有のビューから、サブキーとその値を削除します。 キー名では大文字と小文字は区別されないことに注意してください。
構文
LSTATUS RegDeleteKeyTransactedA(
[in] HKEY hKey,
[in] LPCSTR lpSubKey,
[in] REGSAM samDesired,
DWORD Reserved,
[in] HANDLE hTransaction,
PVOID pExtendedParameter
);
パラメーター
[in] hKey
開いているレジストリ キーへのハンドル。 このキーのアクセス権は、削除操作には影響しません。 アクセス権の詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。
このハンドルは、 RegCreateKeyEx、 RegCreateKeyTransacted、 RegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。 また、次のいずれかの 定義済みキーを指定することもできます。
- HKEY_CLASSES_ROOT
- HKEY_CURRENT_CONFIG
- HKEY_CURRENT_USER
- HKEY_LOCAL_MACHINE
- HKEY_USERS
[in] lpSubKey
削除するキーの名前。 このキーは、 hKey パラメーターの値で指定されたキーのサブキーである必要があります。
関数は、DELETE アクセス権を持つサブキーを開きます。
キー名では大文字と小文字は区別されません。
このパラメーターの値を NULL にすることはできません。
[in] samDesired
アクセス マスク は、レジストリのプラットフォーム固有のビューを指定します。
値 | 説明 |
---|---|
|
32 ビット レジストリ ビューからキーを削除します。 |
|
64 ビット レジストリ ビューからキーを削除します。 |
Reserved
このパラメーターは予約されており、0 である必要があります。
[in] hTransaction
アクティブなトランザクションへのハンドル。 このハンドルは、 CreateTransaction 関数によって返されます。
pExtendedParameter
このパラメーターは予約されており、 NULL である必要があります。
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラー コードです。 FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage 関数を使用すると、エラーの一般的な説明を取得できます。
解説
削除されたキーは、最後のハンドルが閉じられるまで削除されません。
WOW64 では、32 ビット アプリケーションは、64 ビット アプリケーションが表示するレジストリ ツリーとは別のレジストリ ツリーを表示します。 この関数を使用すると、アプリケーションは代替レジストリ ビューのエントリを削除できます。
削除するサブキーにサブキーを含めてはなりません。 キーとそのすべてのサブキーを削除するには、サブキーを列挙して個別に削除する必要があります。 キーを再帰的に削除するには、 RegDeleteTree または SHDeleteKey 関数を 使用します。
関数が成功すると、 RegDeleteKeyTransacted は指定されたキーをレジストリから削除します。 すべての値を含むキー全体が削除されます。 トランザクション操作としてツリー全体を削除するには、 RegDeleteTree 関数を使用し、 RegCreateKeyTransacted または RegOpenKeyTransacted から返されるハンドルを指定 します。
Note
winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegDeleteKeyTransacted を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | winreg.h (Windows.h を含む) |
Library | Advapi32.lib |
[DLL] | Advapi32.dll |