RegLoadKeyA
関数シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR RegLoadKeyA(
HKEY hKey,
LPCSTR lpSubKey, // optional
LPCSTR lpFile
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hKey | HKEY | in | サブキーが作成されるキーへのハンドルです。これは RegConnectRegistry の呼び出しによって返されたハンドル、または次のいずれかの定義済みハンドルを指定できます。 HKEY_LOCAL_MACHINE HKEY_USERS この関数は常にレジストリ階層の最上位に情報を読み込みます。HKEY_CLASSES_ROOT および HKEY_CURRENT_USER のハンドル値は、それぞれ HKEY_LOCAL_MACHINE および HKEY_USERS のハンドル値のサブセットを表すため、このパラメーターには指定できません。 |
| lpSubKey | LPCSTR | inoptional | hKey の下に作成するキーの名前です。このサブキーは、ファイルからの登録情報が読み込まれる場所です。 キー名は大文字と小文字を区別しません。 詳細については、 Registry Element Size Limits を参照してください。 |
| lpFile | LPCSTR | in | レジストリデータを含むファイルの名前です。このファイルは、 RegSaveKey 関数で作成されたローカルファイルである必要があります。このファイルが存在しない場合は、指定された名前でファイルが作成されます。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
HKEY_USERS または HKEY_LOCAL_MACHINE の下にサブキーを作成し、指定されたレジストリハイブのデータをそのサブキーに読み込みます。(ANSI)
戻り値
関数が成功した場合、戻り値は ERROR_SUCCESS です。
関数が失敗した場合、戻り値は Winerror.h に定義されている 0 以外のエラーコードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグと共に使用すると、エラーの一般的な説明を取得できます。
解説(Remarks)
レジストリハイブファイルの形式には 2 種類あります。現在のオペレーティングシステムで作成されたレジストリハイブは、通常、それ以前のオペレーティングシステムでは読み込めません。
hKey が RegConnectRegistry によって返されたハンドルである場合、lpFile に指定されたパスはリモートコンピューターからの相対パスになります。
呼び出し元のプロセスは、レジストリが存在するコンピューター上で SE_RESTORE_NAME および SE_BACKUP_NAME 特権を持っている必要があります。詳細については、 Running with Special Privileges を参照してください。これらの特別な特権を必要とせずにハイブを読み込むには、RegLoadAppKey 関数を使用してください。
winreg.h ヘッダーは RegLoadKey を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
WIN32_ERROR RegLoadKeyA(
HKEY hKey,
LPCSTR lpSubKey, // optional
LPCSTR lpFile
);[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegLoadKeyA(
IntPtr hKey, // HKEY
[MarshalAs(UnmanagedType.LPStr)] string lpSubKey, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string lpFile // LPCSTR
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegLoadKeyA(
hKey As IntPtr, ' HKEY
<MarshalAs(UnmanagedType.LPStr)> lpSubKey As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> lpFile As String ' LPCSTR
) As UInteger
End Function' hKey : HKEY
' lpSubKey : LPCSTR optional
' lpFile : LPCSTR
Declare PtrSafe Function RegLoadKeyA Lib "advapi32" ( _
ByVal hKey As LongPtr, _
ByVal lpSubKey As String, _
ByVal lpFile As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RegLoadKeyA = ctypes.windll.advapi32.RegLoadKeyA
RegLoadKeyA.restype = wintypes.DWORD
RegLoadKeyA.argtypes = [
wintypes.HANDLE, # hKey : HKEY
wintypes.LPCSTR, # lpSubKey : LPCSTR optional
wintypes.LPCSTR, # lpFile : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
RegLoadKeyA = Fiddle::Function.new(
lib['RegLoadKeyA'],
[
Fiddle::TYPE_VOIDP, # hKey : HKEY
Fiddle::TYPE_VOIDP, # lpSubKey : LPCSTR optional
Fiddle::TYPE_VOIDP, # lpFile : LPCSTR
],
-Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn RegLoadKeyA(
hKey: *mut core::ffi::c_void, // HKEY
lpSubKey: *const u8, // LPCSTR optional
lpFile: *const u8 // LPCSTR
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegLoadKeyA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, [MarshalAs(UnmanagedType.LPStr)] string lpFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegLoadKeyA' -Namespace Win32 -PassThru
# $api::RegLoadKeyA(hKey, lpSubKey, lpFile)#uselib "ADVAPI32.dll"
#func global RegLoadKeyA "RegLoadKeyA" sptr, sptr, sptr
; RegLoadKeyA hKey, lpSubKey, lpFile ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "sptr"
; lpFile : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global RegLoadKeyA "RegLoadKeyA" sptr, str, str
; res = RegLoadKeyA(hKey, lpSubKey, lpFile)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "str"
; lpFile : LPCSTR -> "str"; WIN32_ERROR RegLoadKeyA(HKEY hKey, LPCSTR lpSubKey, LPCSTR lpFile)
#uselib "ADVAPI32.dll"
#cfunc global RegLoadKeyA "RegLoadKeyA" intptr, str, str
; res = RegLoadKeyA(hKey, lpSubKey, lpFile)
; hKey : HKEY -> "intptr"
; lpSubKey : LPCSTR optional -> "str"
; lpFile : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procRegLoadKeyA = advapi32.NewProc("RegLoadKeyA")
)
// hKey (HKEY), lpSubKey (LPCSTR optional), lpFile (LPCSTR)
r1, _, err := procRegLoadKeyA.Call(
uintptr(hKey),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSubKey))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFile))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction RegLoadKeyA(
hKey: THandle; // HKEY
lpSubKey: PAnsiChar; // LPCSTR optional
lpFile: PAnsiChar // LPCSTR
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegLoadKeyA';result := DllCall("ADVAPI32\RegLoadKeyA"
, "Ptr", hKey ; HKEY
, "AStr", lpSubKey ; LPCSTR optional
, "AStr", lpFile ; LPCSTR
, "UInt") ; return: WIN32_ERROR●RegLoadKeyA(hKey, lpSubKey, lpFile) = DLL("ADVAPI32.dll", "dword RegLoadKeyA(void*, char*, char*)")
# 呼び出し: RegLoadKeyA(hKey, lpSubKey, lpFile)
# hKey : HKEY -> "void*"
# lpSubKey : LPCSTR optional -> "char*"
# lpFile : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn RegLoadKeyA(
hKey: ?*anyopaque, // HKEY
lpSubKey: [*c]const u8, // LPCSTR optional
lpFile: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;proc RegLoadKeyA(
hKey: pointer, # HKEY
lpSubKey: cstring, # LPCSTR optional
lpFile: cstring # LPCSTR
): uint32 {.importc: "RegLoadKeyA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
uint RegLoadKeyA(
void* hKey, // HKEY
const(char)* lpSubKey, // LPCSTR optional
const(char)* lpFile // LPCSTR
);ccall((:RegLoadKeyA, "ADVAPI32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Cstring, Cstring),
hKey, lpSubKey, lpFile)
# hKey : HKEY -> Ptr{Cvoid}
# lpSubKey : LPCSTR optional -> Cstring
# lpFile : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t RegLoadKeyA(
void* hKey,
const char* lpSubKey,
const char* lpFile);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegLoadKeyA(hKey, lpSubKey, lpFile)
-- hKey : HKEY
-- lpSubKey : LPCSTR optional
-- lpFile : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegLoadKeyA = lib.func('__stdcall', 'RegLoadKeyA', 'uint32_t', ['void *', 'str', 'str']);
// RegLoadKeyA(hKey, lpSubKey, lpFile)
// hKey : HKEY -> 'void *'
// lpSubKey : LPCSTR optional -> 'str'
// lpFile : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
RegLoadKeyA: { parameters: ["pointer", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.RegLoadKeyA(hKey, lpSubKey, lpFile)
// hKey : HKEY -> "pointer"
// lpSubKey : LPCSTR optional -> "buffer"
// lpFile : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t RegLoadKeyA(
void* hKey,
const char* lpSubKey,
const char* lpFile);
C, "ADVAPI32.dll");
// $ffi->RegLoadKeyA(hKey, lpSubKey, lpFile);
// hKey : HKEY
// lpSubKey : LPCSTR optional
// lpFile : LPCSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Advapi32 extends StdCallLibrary {
Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
int RegLoadKeyA(
Pointer hKey, // HKEY
String lpSubKey, // LPCSTR optional
String lpFile // LPCSTR
);
}@[Link("advapi32")]
lib LibADVAPI32
fun RegLoadKeyA = RegLoadKeyA(
hKey : Void*, # HKEY
lpSubKey : UInt8*, # LPCSTR optional
lpFile : UInt8* # LPCSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RegLoadKeyANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>);
typedef RegLoadKeyADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>);
final RegLoadKeyA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<RegLoadKeyANative, RegLoadKeyADart>('RegLoadKeyA');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCSTR optional -> Pointer<Utf8>
// lpFile : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RegLoadKeyA(
hKey: THandle; // HKEY
lpSubKey: PAnsiChar; // LPCSTR optional
lpFile: PAnsiChar // LPCSTR
): DWORD; stdcall;
external 'ADVAPI32.dll' name 'RegLoadKeyA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RegLoadKeyA"
c_RegLoadKeyA :: Ptr () -> CString -> CString -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCSTR optional -> CString
-- lpFile : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let regloadkeya =
foreign "RegLoadKeyA"
((ptr void) @-> string @-> string @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCSTR optional -> string *)
(* lpFile : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("RegLoadKeyA" reg-load-key-a :convention :stdcall) :uint32
(h-key :pointer) ; HKEY
(lp-sub-key :string) ; LPCSTR optional
(lp-file :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RegLoadKeyA = Win32::API::More->new('ADVAPI32',
'DWORD RegLoadKeyA(HANDLE hKey, LPCSTR lpSubKey, LPCSTR lpFile)');
# my $ret = $RegLoadKeyA->Call($hKey, $lpSubKey, $lpFile);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR optional -> LPCSTR
# lpFile : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RegLoadKeyW (Unicode版) — ハイブファイルをレジストリのサブキーとして読み込む。
- f RegConnectRegistryA — リモートコンピューターの定義済みレジストリキーに接続する。
- f RegDeleteKeyA — 指定したサブキーをレジストリから削除する。
- f RegLoadAppKeyA — アプリ専用のハイブファイルをプライベートキーとして読み込む。
- f RegReplaceKeyA — 指定キーのバックアップ用ファイルを置き換える。
- f RegRestoreKeyA — 保存済みハイブファイルから指定キーを復元する。
- f RegSaveKeyA — 指定キーとサブキーをファイルに保存する。
- f RegUnLoadKeyA — 読み込み済みのハイブをレジストリからアンロードする。