Win32 API 日本語リファレンス
ホームSystem.Registry › RegOpenKeyExA

RegOpenKeyExA

関数
アクセス権を指定してレジストリキーを開く。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR RegOpenKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    DWORD ulOptions,   // optional
    REG_SAM_FLAGS samDesired,
    HKEY* phkResult
);

パラメーター

名前方向説明
hKeyHKEYin

開いているレジストリ キーへのハンドル。このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されるか、次のいずれかの 定義済みキー を指定できます。

HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS

lpSubKeyLPCSTRinoptional

開くレジストリ サブキーの名前。

キー名は大文字と小文字を区別しません。

lpSubKey パラメーターが NULL または空の文字列へのポインターであり、かつ hKey が定義済みキーである場合、システムは定義済みキーを更新し、phkResult には関数に渡されたものと同じ hKey ハンドルが格納されます。それ以外の場合、phkResult には開かれたキーへの新しいハンドルが格納されます。

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

ulOptionsDWORDinoptional

キーを開く際に適用するオプションを指定します。このパラメーターには 0 または次の値を設定します。

意味
REG_OPTION_OPEN_LINK
キーはシンボリック リンクです。レジストリのシンボリック リンクは、どうしても必要な場合にのみ使用してください。
samDesiredREG_SAM_FLAGSin開くキーに対して必要とするアクセス権を指定するマスク。キーのセキュリティ記述子が呼び出し元プロセスに対して要求されたアクセスを許可しない場合、この関数は失敗します。詳細については、 レジストリ キーのセキュリティとアクセス権 を参照してください。
phkResultHKEY*out開かれたキーへのハンドルを受け取る変数へのポインター。キーが定義済みレジストリ キーのいずれでもない場合は、ハンドルの使用が終わった後に RegCloseKey 関数を呼び出してください。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたレジストリ キーを開きます。キー名は大文字と小文字を区別しないことに注意してください。(ANSI)

戻り値

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

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

メモ

以前のバージョンの Windows では、この API は kernel32.dll でも公開されています。

解説(Remarks)

RegCreateKeyEx 関数とは異なり、 RegOpenKeyEx 関数は、指定されたキーがレジストリに存在しない場合でも、そのキーを作成しません。

一部のレジストリ操作では、ハンドルを取得した際に指定されたアクセス マスクではなく、キーのセキュリティ記述子に対してアクセス チェックが実行されます。たとえば、キーを KEY_READsamDesired で開いた場合でも、キーのセキュリティ記述子が許可していれば、そのキーを使用してレジストリ キーを作成できます。一方、RegSetValueEx 関数では、キーが KEY_SET_VALUE アクセス権で開かれていることが明確に要求されます。

サービスやアプリケーションが異なるユーザーを偽装する場合は、この関数を HKEY_CURRENT_USER とともに使用しないでください。代わりに RegOpenCurrentUser 関数を呼び出してください。

特定のレジストリ キーにアクセスする操作はリダイレクトされる点に注意してください。詳細については、レジストリの仮想化 および レジストリにおける 32 ビットおよび 64 ビット アプリケーション データ を参照してください。

lResult = RegOpenKeyEx (hKeyRoot, lpSubKey, 0, KEY_READ, &hKey);

if (lResult != ERROR_SUCCESS) 
{
    if (lResult == ERROR_FILE_NOT_FOUND) {
        printf("Key not found.\n");
        return TRUE;
    } 
    else {
        printf("Error opening key.\n");
        return FALSE;
    }
}

この例を文脈の中で確認するには、 サブキーを持つキーの削除 を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegOpenKeyExA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    DWORD ulOptions,   // optional
    REG_SAM_FLAGS samDesired,
    HKEY* phkResult
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RegOpenKeyExA(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPStr)] string lpSubKey,   // LPCSTR optional
    uint ulOptions,   // DWORD optional
    uint samDesired,   // REG_SAM_FLAGS
    IntPtr phkResult   // HKEY* out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RegOpenKeyExA(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPStr)> lpSubKey As String,   ' LPCSTR optional
    ulOptions As UInteger,   ' DWORD optional
    samDesired As UInteger,   ' REG_SAM_FLAGS
    phkResult As IntPtr   ' HKEY* out
) As UInteger
End Function
' hKey : HKEY
' lpSubKey : LPCSTR optional
' ulOptions : DWORD optional
' samDesired : REG_SAM_FLAGS
' phkResult : HKEY* out
Declare PtrSafe Function RegOpenKeyExA Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpSubKey As String, _
    ByVal ulOptions As Long, _
    ByVal samDesired As Long, _
    ByVal phkResult As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegOpenKeyExA = ctypes.windll.advapi32.RegOpenKeyExA
RegOpenKeyExA.restype = wintypes.DWORD
RegOpenKeyExA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR optional
    wintypes.DWORD,  # ulOptions : DWORD optional
    wintypes.DWORD,  # samDesired : REG_SAM_FLAGS
    ctypes.c_void_p,  # phkResult : HKEY* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
RegOpenKeyExA = Fiddle::Function.new(
  lib['RegOpenKeyExA'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
    Fiddle::TYPE_VOIDP,  # lpSubKey : LPCSTR optional
    -Fiddle::TYPE_INT,  # ulOptions : DWORD optional
    -Fiddle::TYPE_INT,  # samDesired : REG_SAM_FLAGS
    Fiddle::TYPE_VOIDP,  # phkResult : HKEY* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn RegOpenKeyExA(
        hKey: *mut core::ffi::c_void,  // HKEY
        lpSubKey: *const u8,  // LPCSTR optional
        ulOptions: u32,  // DWORD optional
        samDesired: u32,  // REG_SAM_FLAGS
        phkResult: *mut *mut core::ffi::c_void  // HKEY* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RegOpenKeyExA(IntPtr hKey, [MarshalAs(UnmanagedType.LPStr)] string lpSubKey, uint ulOptions, uint samDesired, IntPtr phkResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegOpenKeyExA' -Namespace Win32 -PassThru
# $api::RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
#uselib "ADVAPI32.dll"
#func global RegOpenKeyExA "RegOpenKeyExA" sptr, sptr, sptr, sptr, sptr
; RegOpenKeyExA hKey, lpSubKey, ulOptions, samDesired, phkResult   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "sptr"
; ulOptions : DWORD optional -> "sptr"
; samDesired : REG_SAM_FLAGS -> "sptr"
; phkResult : HKEY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegOpenKeyExA "RegOpenKeyExA" sptr, str, int, int, sptr
; res = RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
; hKey : HKEY -> "sptr"
; lpSubKey : LPCSTR optional -> "str"
; ulOptions : DWORD optional -> "int"
; samDesired : REG_SAM_FLAGS -> "int"
; phkResult : HKEY* out -> "sptr"
; WIN32_ERROR RegOpenKeyExA(HKEY hKey, LPCSTR lpSubKey, DWORD ulOptions, REG_SAM_FLAGS samDesired, HKEY* phkResult)
#uselib "ADVAPI32.dll"
#cfunc global RegOpenKeyExA "RegOpenKeyExA" intptr, str, int, int, intptr
; res = RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
; hKey : HKEY -> "intptr"
; lpSubKey : LPCSTR optional -> "str"
; ulOptions : DWORD optional -> "int"
; samDesired : REG_SAM_FLAGS -> "int"
; phkResult : HKEY* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegOpenKeyExA = advapi32.NewProc("RegOpenKeyExA")
)

// hKey (HKEY), lpSubKey (LPCSTR optional), ulOptions (DWORD optional), samDesired (REG_SAM_FLAGS), phkResult (HKEY* out)
r1, _, err := procRegOpenKeyExA.Call(
	uintptr(hKey),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSubKey))),
	uintptr(ulOptions),
	uintptr(samDesired),
	uintptr(phkResult),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RegOpenKeyExA(
  hKey: THandle;   // HKEY
  lpSubKey: PAnsiChar;   // LPCSTR optional
  ulOptions: DWORD;   // DWORD optional
  samDesired: DWORD;   // REG_SAM_FLAGS
  phkResult: Pointer   // HKEY* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegOpenKeyExA';
result := DllCall("ADVAPI32\RegOpenKeyExA"
    , "Ptr", hKey   ; HKEY
    , "AStr", lpSubKey   ; LPCSTR optional
    , "UInt", ulOptions   ; DWORD optional
    , "UInt", samDesired   ; REG_SAM_FLAGS
    , "Ptr", phkResult   ; HKEY* out
    , "UInt")   ; return: WIN32_ERROR
●RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult) = DLL("ADVAPI32.dll", "dword RegOpenKeyExA(void*, char*, dword, dword, void*)")
# 呼び出し: RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
# hKey : HKEY -> "void*"
# lpSubKey : LPCSTR optional -> "char*"
# ulOptions : DWORD optional -> "dword"
# samDesired : REG_SAM_FLAGS -> "dword"
# phkResult : HKEY* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn RegOpenKeyExA(
    hKey: ?*anyopaque, // HKEY
    lpSubKey: [*c]const u8, // LPCSTR optional
    ulOptions: u32, // DWORD optional
    samDesired: u32, // REG_SAM_FLAGS
    phkResult: ?*anyopaque // HKEY* out
) callconv(std.os.windows.WINAPI) u32;
proc RegOpenKeyExA(
    hKey: pointer,  # HKEY
    lpSubKey: cstring,  # LPCSTR optional
    ulOptions: uint32,  # DWORD optional
    samDesired: uint32,  # REG_SAM_FLAGS
    phkResult: pointer  # HKEY* out
): uint32 {.importc: "RegOpenKeyExA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint RegOpenKeyExA(
    void* hKey,   // HKEY
    const(char)* lpSubKey,   // LPCSTR optional
    uint ulOptions,   // DWORD optional
    uint samDesired,   // REG_SAM_FLAGS
    void* phkResult   // HKEY* out
);
ccall((:RegOpenKeyExA, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, UInt32, UInt32, Ptr{Cvoid}),
      hKey, lpSubKey, ulOptions, samDesired, phkResult)
# hKey : HKEY -> Ptr{Cvoid}
# lpSubKey : LPCSTR optional -> Cstring
# ulOptions : DWORD optional -> UInt32
# samDesired : REG_SAM_FLAGS -> UInt32
# phkResult : HKEY* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RegOpenKeyExA(
    void* hKey,
    const char* lpSubKey,
    uint32_t ulOptions,
    uint32_t samDesired,
    void* phkResult);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
-- hKey : HKEY
-- lpSubKey : LPCSTR optional
-- ulOptions : DWORD optional
-- samDesired : REG_SAM_FLAGS
-- phkResult : HKEY* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegOpenKeyExA = lib.func('__stdcall', 'RegOpenKeyExA', 'uint32_t', ['void *', 'str', 'uint32_t', 'uint32_t', 'void *']);
// RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
// hKey : HKEY -> 'void *'
// lpSubKey : LPCSTR optional -> 'str'
// ulOptions : DWORD optional -> 'uint32_t'
// samDesired : REG_SAM_FLAGS -> 'uint32_t'
// phkResult : HKEY* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  RegOpenKeyExA: { parameters: ["pointer", "buffer", "u32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult)
// hKey : HKEY -> "pointer"
// lpSubKey : LPCSTR optional -> "buffer"
// ulOptions : DWORD optional -> "u32"
// samDesired : REG_SAM_FLAGS -> "u32"
// phkResult : HKEY* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RegOpenKeyExA(
    void* hKey,
    const char* lpSubKey,
    uint32_t ulOptions,
    uint32_t samDesired,
    void* phkResult);
C, "ADVAPI32.dll");
// $ffi->RegOpenKeyExA(hKey, lpSubKey, ulOptions, samDesired, phkResult);
// hKey : HKEY
// lpSubKey : LPCSTR optional
// ulOptions : DWORD optional
// samDesired : REG_SAM_FLAGS
// phkResult : HKEY* out
// 構造体/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 RegOpenKeyExA(
        Pointer hKey,   // HKEY
        String lpSubKey,   // LPCSTR optional
        int ulOptions,   // DWORD optional
        int samDesired,   // REG_SAM_FLAGS
        Pointer phkResult   // HKEY* out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun RegOpenKeyExA = RegOpenKeyExA(
    hKey : Void*,   # HKEY
    lpSubKey : UInt8*,   # LPCSTR optional
    ulOptions : UInt32,   # DWORD optional
    samDesired : UInt32,   # REG_SAM_FLAGS
    phkResult : Void*   # HKEY* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RegOpenKeyExANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Uint32, Pointer<Void>);
typedef RegOpenKeyExADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int, Pointer<Void>);
final RegOpenKeyExA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegOpenKeyExANative, RegOpenKeyExADart>('RegOpenKeyExA');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCSTR optional -> Pointer<Utf8>
// ulOptions : DWORD optional -> Uint32
// samDesired : REG_SAM_FLAGS -> Uint32
// phkResult : HKEY* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegOpenKeyExA(
  hKey: THandle;   // HKEY
  lpSubKey: PAnsiChar;   // LPCSTR optional
  ulOptions: DWORD;   // DWORD optional
  samDesired: DWORD;   // REG_SAM_FLAGS
  phkResult: Pointer   // HKEY* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegOpenKeyExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegOpenKeyExA"
  c_RegOpenKeyExA :: Ptr () -> CString -> Word32 -> Word32 -> Ptr () -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCSTR optional -> CString
-- ulOptions : DWORD optional -> Word32
-- samDesired : REG_SAM_FLAGS -> Word32
-- phkResult : HKEY* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let regopenkeyexa =
  foreign "RegOpenKeyExA"
    ((ptr void) @-> string @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKey : LPCSTR optional -> string *)
(* ulOptions : DWORD optional -> uint32_t *)
(* samDesired : REG_SAM_FLAGS -> uint32_t *)
(* phkResult : HKEY* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegOpenKeyExA" reg-open-key-ex-a :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (lp-sub-key :string)   ; LPCSTR optional
  (ul-options :uint32)   ; DWORD optional
  (sam-desired :uint32)   ; REG_SAM_FLAGS
  (phk-result :pointer))   ; HKEY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegOpenKeyExA = Win32::API::More->new('ADVAPI32',
    'DWORD RegOpenKeyExA(HANDLE hKey, LPCSTR lpSubKey, DWORD ulOptions, DWORD samDesired, HANDLE phkResult)');
# my $ret = $RegOpenKeyExA->Call($hKey, $lpSubKey, $ulOptions, $samDesired, $phkResult);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR optional -> LPCSTR
# ulOptions : DWORD optional -> DWORD
# samDesired : REG_SAM_FLAGS -> DWORD
# phkResult : HKEY* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型