RegRestoreKeyW

指定したファイル内のレジストリ情報を読み取り、指定したキーの上にコピーする。このレジストリ情報はキーと複数レベルのサブキーの形式をとることができる。(Unicode)

RegRestoreKeyW hKey, lpFile, dwFlags

hKey : [intptr] 開かれているレジストリキーへのハンドル。このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数が返す。以下の定義済みキーのいずれかを指定することもできる:
lpFile : [wstr] レジストリ情報を含むファイルの名前。このファイルは通常、RegSaveKey 関数を使用して作成される。
dwFlags : [int] 

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

解説

指定したファイル内のレジストリ情報を読み取り、指定したキーの上にコピーする。このレジストリ情報はキーと複数レベルのサブキーの形式をとることができる。(Unicode)

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

[備考]
レジストリハイブファイルには 2
つの異なる形式がある。現在のオペレーティングシステムで作成されたレジストリハイブは、通常、それ以前のバージョンではロードできない。hKey
パラメータのサブキーが開かれている場合、RegRestoreKey は失敗する。呼び出し側プロセスはレジストリが存在するコンピュータ上で
SE_RESTORE_NAME および SE_BACKUP_NAME
特権を持っている必要がある。詳細は特殊な特権での実行を参照のこと。この関数は、ファイル内の最上位キーの名前にかかわらず、指定したキー配下のキーと値を、ファイル内の最上位キーに従属するキーと値で置き換える。たとえば、hKey
がサブキー B と C を持つキー A を識別し、lpFile パラメータがサブキー Y と Z を持つキー X
を含むファイルを指定する場合、RegRestoreKey の呼び出し後、レジストリはサブキー Y と Z を持つキー A
を含むことになる。A の値エントリは X の値エントリで置き換えられる。キー名を除き、lpFile で指定したファイル内の新しい情報が
hKey パラメータで指定したキーの内容を上書きする。hKey がリモートコンピュータ上のキーを表す場合、lpFile
で指定されたパスはリモートコンピュータに対する相対となる。
> [!NOTE] > winreg.h ヘッダは RegRestoreKey をエイリアスとして定義しており、UNICODE
プリプロセッサ定数の定義に基づいて ANSI または Unicode
版を自動的に選択する。エンコーディングに中立なエイリアスをエンコーディング中立でないコードと混在させると、コンパイル時または実行時エラーとなる可能性がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照のこと。

情報

プラグイン / モジュールadvapi32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の advapi32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_advapi32_gen2.hs