RegLoadAppKeyA

関数

アプリ専用のハイブファイルをプライベートキーとして読み込む。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegLoadAppKeyA(
    LPCSTR lpFile,
    HKEY* phkResult,
    DWORD samDesired,
    DWORD dwOptions,
    DWORD Reserved   // optional
);

パラメーター

名前	型	方向	説明
lpFile	LPCSTR	in	ハイブファイルの名前。このハイブは RegSaveKey または RegSaveKeyEx 関数で作成されている必要があります。ファイルが存在しない場合は、指定された名前で空のハイブファイルが作成されます。
phkResult	HKEY*	out	読み込まれたハイブのルートキーに対するハンドルへのポインター。ハイブ内のキーにアクセスする唯一の方法は、このハンドルを介することです。レジストリは、アプリケーションがキーへの絶対パスを使用してこのハイブ内のキーにアクセスするのを防ぎます。そのため、レジストリの名前空間を通じてこのハイブに移動することはできません。
samDesired	DWORD	in	返されるルートキーに対して要求するアクセス権を指定するマスク。詳細については、 Registry Key Security and Access Rights を参照してください。
dwOptions	DWORD	in	このパラメーターが REG_PROCESS_APPKEY の場合、ハイブは呼び出し元によって読み込まれている間、再度読み込むことはできません。これにより、別の呼び出し元がこのレジストリハイブにアクセスすることを防ぎます。
Reserved	DWORD	optional	このパラメーターは予約されています。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたレジストリハイブをアプリケーションハイブとして読み込みます。(ANSI)

戻り値

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

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

解説(Remarks)

RegLoadKey とは異なり、RegLoadAppKey はハイブを HKEY_LOCAL_MACHINE または HKEY_USERS の下に読み込みません。代わりに、ハイブは列挙できない特別なルートの下に読み込まれます。そのため、RegLoadAppKey によって現在読み込まれているハイブを列挙する方法はありません。RegLoadAppKey によって読み込まれたハイブに対するすべての操作は、phkResult で返されたハンドルを基準にして実行する必要があります。

2 つのプロセスが同じハイブに対して操作を実行する必要がある場合、各プロセスはハンドルを取得するために RegLoadAppKey を呼び出す必要があります。RegLoadAppKey の操作中、レジストリはファイルが既に読み込まれているかどうかを確認します。既に読み込まれている場合、レジストリはハイブを再読み込みするのではなく、以前に読み込まれたハイブへのハンドルを返します。

ハイブ内のすべてのキーは同じセキュリティ記述子を持っている必要があり、そうでない場合は関数が失敗します。このセキュリティ記述子は、samDesired パラメーターで指定されたアクセスを呼び出し元に許可している必要があり、そうでない場合は関数が失敗します。ハイブ内のいかなるキーに対しても RegSetKeySecurity 関数を使用することはできません。

Windows 8 以降では、各プロセスは RegLoadAppKey を呼び出して複数のハイブを読み込むことができます。Windows 7 以前では、各プロセスは RegLoadAppKey を使用して一度に 1 つのハイブのみを読み込むことができます。

RegLoadAppKey を使用して読み込まれたハイブは、ハイブ内のキーへのすべてのハンドルが RegCloseKey を使用して閉じられると、自動的にアンロードされます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

メモ

winreg.h ヘッダーは RegLoadAppKey を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコードニュートラルなエイリアスの使用を、エンコードニュートラルでないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR RegLoadAppKeyA(
    LPCSTR lpFile,
    HKEY* phkResult,
    DWORD samDesired,
    DWORD dwOptions,
    DWORD Reserved   // optional
);

[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegLoadAppKeyA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFile,   // LPCSTR
    IntPtr phkResult,   // HKEY* out
    uint samDesired,   // DWORD
    uint dwOptions,   // DWORD
    uint Reserved   // DWORD optional
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegLoadAppKeyA(
    <MarshalAs(UnmanagedType.LPStr)> lpFile As String,   ' LPCSTR
    phkResult As IntPtr,   ' HKEY* out
    samDesired As UInteger,   ' DWORD
    dwOptions As UInteger,   ' DWORD
    Reserved As UInteger   ' DWORD optional
) As UInteger
End Function

' lpFile : LPCSTR
' phkResult : HKEY* out
' samDesired : DWORD
' dwOptions : DWORD
' Reserved : DWORD optional
Declare PtrSafe Function RegLoadAppKeyA Lib "advapi32" ( _
    ByVal lpFile As String, _
    ByVal phkResult As LongPtr, _
    ByVal samDesired As Long, _
    ByVal dwOptions As Long, _
    ByVal Reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegLoadAppKeyA = ctypes.windll.advapi32.RegLoadAppKeyA
RegLoadAppKeyA.restype = wintypes.DWORD
RegLoadAppKeyA.argtypes = [
    wintypes.LPCSTR,  # lpFile : LPCSTR
    ctypes.c_void_p,  # phkResult : HKEY* out
    wintypes.DWORD,  # samDesired : DWORD
    wintypes.DWORD,  # dwOptions : DWORD
    wintypes.DWORD,  # Reserved : DWORD optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegLoadAppKeyA = Fiddle::Function.new(
  lib['RegLoadAppKeyA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFile : LPCSTR
    Fiddle::TYPE_VOIDP,  # phkResult : HKEY* out
    -Fiddle::TYPE_INT,  # samDesired : DWORD
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn RegLoadAppKeyA(
        lpFile: *const u8,  // LPCSTR
        phkResult: *mut *mut core::ffi::c_void,  // HKEY* out
        samDesired: u32,  // DWORD
        dwOptions: u32,  // DWORD
        Reserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegLoadAppKeyA([MarshalAs(UnmanagedType.LPStr)] string lpFile, IntPtr phkResult, uint samDesired, uint dwOptions, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegLoadAppKeyA' -Namespace Win32 -PassThru
# $api::RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)

#uselib "ADVAPI32.dll"
#func global RegLoadAppKeyA "RegLoadAppKeyA" sptr, sptr, sptr, sptr, sptr
; RegLoadAppKeyA lpFile, phkResult, samDesired, dwOptions, Reserved   ; 戻り値は stat
; lpFile : LPCSTR -> "sptr"
; phkResult : HKEY* out -> "sptr"
; samDesired : DWORD -> "sptr"
; dwOptions : DWORD -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "ADVAPI32.dll"
#cfunc global RegLoadAppKeyA "RegLoadAppKeyA" str, sptr, int, int, int
; res = RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
; lpFile : LPCSTR -> "str"
; phkResult : HKEY* out -> "sptr"
; samDesired : DWORD -> "int"
; dwOptions : DWORD -> "int"
; Reserved : DWORD optional -> "int"

; WIN32_ERROR RegLoadAppKeyA(LPCSTR lpFile, HKEY* phkResult, DWORD samDesired, DWORD dwOptions, DWORD Reserved)
#uselib "ADVAPI32.dll"
#cfunc global RegLoadAppKeyA "RegLoadAppKeyA" str, intptr, int, int, int
; res = RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
; lpFile : LPCSTR -> "str"
; phkResult : HKEY* out -> "intptr"
; samDesired : DWORD -> "int"
; dwOptions : DWORD -> "int"
; Reserved : DWORD optional -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegLoadAppKeyA = advapi32.NewProc("RegLoadAppKeyA")
)

// lpFile (LPCSTR), phkResult (HKEY* out), samDesired (DWORD), dwOptions (DWORD), Reserved (DWORD optional)
r1, _, err := procRegLoadAppKeyA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFile))),
	uintptr(phkResult),
	uintptr(samDesired),
	uintptr(dwOptions),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR

function RegLoadAppKeyA(
  lpFile: PAnsiChar;   // LPCSTR
  phkResult: Pointer;   // HKEY* out
  samDesired: DWORD;   // DWORD
  dwOptions: DWORD;   // DWORD
  Reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegLoadAppKeyA';

result := DllCall("ADVAPI32\RegLoadAppKeyA"
    , "AStr", lpFile   ; LPCSTR
    , "Ptr", phkResult   ; HKEY* out
    , "UInt", samDesired   ; DWORD
    , "UInt", dwOptions   ; DWORD
    , "UInt", Reserved   ; DWORD optional
    , "UInt")   ; return: WIN32_ERROR

●RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved) = DLL("ADVAPI32.dll", "dword RegLoadAppKeyA(char*, void*, dword, dword, dword)")
# 呼び出し: RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
# lpFile : LPCSTR -> "char*"
# phkResult : HKEY* out -> "void*"
# samDesired : DWORD -> "dword"
# dwOptions : DWORD -> "dword"
# Reserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "advapi32" fn RegLoadAppKeyA(
    lpFile: [*c]const u8, // LPCSTR
    phkResult: ?*anyopaque, // HKEY* out
    samDesired: u32, // DWORD
    dwOptions: u32, // DWORD
    Reserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;

proc RegLoadAppKeyA(
    lpFile: cstring,  # LPCSTR
    phkResult: pointer,  # HKEY* out
    samDesired: uint32,  # DWORD
    dwOptions: uint32,  # DWORD
    Reserved: uint32  # DWORD optional
): uint32 {.importc: "RegLoadAppKeyA", stdcall, dynlib: "ADVAPI32.dll".}

pragma(lib, "advapi32");
extern(Windows)
uint RegLoadAppKeyA(
    const(char)* lpFile,   // LPCSTR
    void* phkResult,   // HKEY* out
    uint samDesired,   // DWORD
    uint dwOptions,   // DWORD
    uint Reserved   // DWORD optional
);

ccall((:RegLoadAppKeyA, "ADVAPI32.dll"), stdcall, UInt32,
      (Cstring, Ptr{Cvoid}, UInt32, UInt32, UInt32),
      lpFile, phkResult, samDesired, dwOptions, Reserved)
# lpFile : LPCSTR -> Cstring
# phkResult : HKEY* out -> Ptr{Cvoid}
# samDesired : DWORD -> UInt32
# dwOptions : DWORD -> UInt32
# Reserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t RegLoadAppKeyA(
    const char* lpFile,
    void* phkResult,
    uint32_t samDesired,
    uint32_t dwOptions,
    uint32_t Reserved);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
-- lpFile : LPCSTR
-- phkResult : HKEY* out
-- samDesired : DWORD
-- dwOptions : DWORD
-- Reserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegLoadAppKeyA = lib.func('__stdcall', 'RegLoadAppKeyA', 'uint32_t', ['str', 'void *', 'uint32_t', 'uint32_t', 'uint32_t']);
// RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
// lpFile : LPCSTR -> 'str'
// phkResult : HKEY* out -> 'void *'
// samDesired : DWORD -> 'uint32_t'
// dwOptions : DWORD -> 'uint32_t'
// Reserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("ADVAPI32.dll", {
  RegLoadAppKeyA: { parameters: ["buffer", "pointer", "u32", "u32", "u32"], result: "u32" },
});
// lib.symbols.RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved)
// lpFile : LPCSTR -> "buffer"
// phkResult : HKEY* out -> "pointer"
// samDesired : DWORD -> "u32"
// dwOptions : DWORD -> "u32"
// Reserved : DWORD optional -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t RegLoadAppKeyA(
    const char* lpFile,
    void* phkResult,
    uint32_t samDesired,
    uint32_t dwOptions,
    uint32_t Reserved);
C, "ADVAPI32.dll");
// $ffi->RegLoadAppKeyA(lpFile, phkResult, samDesired, dwOptions, Reserved);
// lpFile : LPCSTR
// phkResult : HKEY* out
// samDesired : DWORD
// dwOptions : DWORD
// Reserved : DWORD optional
// 構造体/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 RegLoadAppKeyA(
        String lpFile,   // LPCSTR
        Pointer phkResult,   // HKEY* out
        int samDesired,   // DWORD
        int dwOptions,   // DWORD
        int Reserved   // DWORD optional
    );
}

@[Link("advapi32")]
lib LibADVAPI32
  fun RegLoadAppKeyA = RegLoadAppKeyA(
    lpFile : UInt8*,   # LPCSTR
    phkResult : Void*,   # HKEY* out
    samDesired : UInt32,   # DWORD
    dwOptions : UInt32,   # DWORD
    Reserved : UInt32   # DWORD optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RegLoadAppKeyANative = Uint32 Function(Pointer<Utf8>, Pointer<Void>, Uint32, Uint32, Uint32);
typedef RegLoadAppKeyADart = int Function(Pointer<Utf8>, Pointer<Void>, int, int, int);
final RegLoadAppKeyA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegLoadAppKeyANative, RegLoadAppKeyADart>('RegLoadAppKeyA');
// lpFile : LPCSTR -> Pointer<Utf8>
// phkResult : HKEY* out -> Pointer<Void>
// samDesired : DWORD -> Uint32
// dwOptions : DWORD -> Uint32
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function RegLoadAppKeyA(
  lpFile: PAnsiChar;   // LPCSTR
  phkResult: Pointer;   // HKEY* out
  samDesired: DWORD;   // DWORD
  dwOptions: DWORD;   // DWORD
  Reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegLoadAppKeyA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegLoadAppKeyA"
  c_RegLoadAppKeyA :: CString -> Ptr () -> Word32 -> Word32 -> Word32 -> IO Word32
-- lpFile : LPCSTR -> CString
-- phkResult : HKEY* out -> Ptr ()
-- samDesired : DWORD -> Word32
-- dwOptions : DWORD -> Word32
-- Reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let regloadappkeya =
  foreign "RegLoadAppKeyA"
    (string @-> (ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* lpFile : LPCSTR -> string *)
(* phkResult : HKEY* out -> (ptr void) *)
(* samDesired : DWORD -> uint32_t *)
(* dwOptions : DWORD -> uint32_t *)
(* Reserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegLoadAppKeyA" reg-load-app-key-a :convention :stdcall) :uint32
  (lp-file :string)   ; LPCSTR
  (phk-result :pointer)   ; HKEY* out
  (sam-desired :uint32)   ; DWORD
  (dw-options :uint32)   ; DWORD
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $RegLoadAppKeyA = Win32::API::More->new('ADVAPI32',
    'DWORD RegLoadAppKeyA(LPCSTR lpFile, HANDLE phkResult, DWORD samDesired, DWORD dwOptions, DWORD Reserved)');
# my $ret = $RegLoadAppKeyA->Call($lpFile, $phkResult, $samDesired, $dwOptions, $Reserved);
# lpFile : LPCSTR -> LPCSTR
# phkResult : HKEY* out -> HANDLE
# samDesired : DWORD -> DWORD
# dwOptions : DWORD -> DWORD
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。