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

RegCloseKey

関数
指定したレジストリキーのハンドルを閉じる。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

WIN32_ERROR RegCloseKey(
    HKEY hKey
);

パラメーター

名前方向説明
hKeyHKEYin閉じる対象の、開かれているキーへのハンドルです。このハンドルは、 RegCreateKeyExRegCreateKeyTransactedRegOpenKeyExRegOpenKeyTransacted、または RegConnectRegistry 関数によって開かれたものである必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定したレジストリキーへのハンドルを閉じます。

戻り値

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

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

解説(Remarks)

指定したキーのハンドルは、閉じた後に使用しないでください。閉じたハンドルはもはや有効ではないためです。キーのハンドルは、必要以上に長く開いたままにしないでください。

RegCloseKey 関数は、戻る前に必ずしもレジストリへ情報を書き込むとは限りません。キャッシュがハードディスクへフラッシュされるまでに数秒かかることもあります。アプリケーションがレジストリ情報を明示的にハードディスクへ書き込む必要がある場合は、 RegFlushKey 関数を使用できます。ただし RegFlushKey は多くのシステムリソースを消費するため、必要な場合にのみ呼び出してください。

例については、 サブキーを持つキーの削除を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

WIN32_ERROR RegCloseKey(
    HKEY hKey
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint RegCloseKey(
    IntPtr hKey   // HKEY
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function RegCloseKey(
    hKey As IntPtr   ' HKEY
) As UInteger
End Function
' hKey : HKEY
Declare PtrSafe Function RegCloseKey Lib "advapi32" ( _
    ByVal hKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegCloseKey = ctypes.windll.advapi32.RegCloseKey
RegCloseKey.restype = wintypes.DWORD
RegCloseKey.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegCloseKey = advapi32.NewProc("RegCloseKey")
)

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

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

typedef RegCloseKeyNative = Uint32 Function(Pointer<Void>);
typedef RegCloseKeyDart = int Function(Pointer<Void>);
final RegCloseKey = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegCloseKeyNative, RegCloseKeyDart>('RegCloseKey');
// hKey : HKEY -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegCloseKey(
  hKey: THandle   // HKEY
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegCloseKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegCloseKey"
  c_RegCloseKey :: Ptr () -> IO Word32
-- hKey : HKEY -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let regclosekey =
  foreign "RegCloseKey"
    ((ptr void) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("RegCloseKey" reg-close-key :convention :stdcall) :uint32
  (h-key :pointer))   ; HKEY
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegCloseKey = Win32::API::More->new('ADVAPI32',
    'DWORD RegCloseKey(HANDLE hKey)');
# my $ret = $RegCloseKey->Call($hKey);
# hKey : HKEY -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型