RegUnLoadKeyA 関数 (winreg.h)

[アーティクル]
03/13/2024

指定したレジストリキーとそのサブキーをレジストリからアンロードします。

システムファイルやレジストリハイブを含むシステム状態をバックアップまたは復元するアプリケーションでは、レジストリ関数の代わりにボリュームシャドウコピーサービスを使用する必要があります。

構文

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

パラメーター

[in] hKey

アンロードするレジストリキーのハンドル。このパラメーターには、 RegConnectRegistry 関数の呼び出しによって返されるハンドル、または次のいずれかの定義済みハンドルを指定できます。

HKEY_LOCAL_MACHINEHKEY_USERS

[in, optional] lpSubKey

アンロードするサブキーの名前。 lpSubKey パラメーターによって参照されるキーは、RegLoadKey 関数を使用して作成されている必要があります。

キー名では大文字と小文字は区別されません。

詳細については、「レジストリ要素のサイズ制限」を参照してください。

戻り値

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

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

注釈

この関数はレジストリからハイブを削除しますが、レジストリ情報を含むファイルは変更しません。 Hive は、レジストリ階層の上部にルート化されたキー、サブキー、および値の個別の本体です。

呼び出し元プロセスには、レジストリが存在するコンピューターに対するSE_RESTORE_NAMEおよびSE_BACKUP_NAME特権が必要です。詳細については、「特別な特権を使用して実行する」を参照してください。

注意

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

要件

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