RegLoadKeyA 関数 (winreg.h)

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

HKEY_USERSまたはHKEY_LOCAL_MACHINEの下にサブキーを作成し、指定したレジストリハイブからそのサブキーにデータを読み込みます。

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

構文

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

パラメーター

[in] hKey

サブキーが作成されるキーへのハンドル。これは、 RegConnectRegistry の呼び出しによって返されるハンドル、または次の定義済みハンドルのいずれかです。

HKEY_LOCAL_MACHINEHKEY_USERS この関数は、常にレジストリ階層の先頭に情報を読み込みます。 HKEY_CLASSES_ROOTとHKEY_CURRENT_USERハンドルの値は、それぞれHKEY_LOCAL_MACHINEのサブセットとHKEY_USERSハンドル値を表すので、このパラメーターに指定できません。

[in, optional] lpSubKey

hKey の下に作成するキーの名前。このサブキーは、ファイルからの登録情報が読み込まれる場所です。

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

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

[in] lpFile

レジストリデータを含むファイルの名前。このファイルは、 RegSaveKey 関数で作成されたローカルファイルである必要があります。このファイルが存在しない場合は、指定した名前のファイルが作成されます。

戻り値

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

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

注釈

レジストリハイブファイル形式は 2 つあります。現在のオペレーティングシステムで作成されたレジストリハイブは、通常、以前のオペレーティングシステムでは読み込めません。

hKey が RegConnectRegistry によって返されるハンドルの場合、lpFile で指定されたパスはリモートコンピューターに対する相対パスです。

呼び出し元のプロセスには、レジストリが存在するコンピューターに対するSE_RESTORE_NAMEとSE_BACKUP_NAMEの特権が必要です。詳細については、「特別な特権を使用して実行する」を参照してください。これらの特別な特権を必要とせずにハイブを読み込むには、 RegLoadAppKey 関数を使用します。

注意

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

要件

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