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

RegFlushKey

関数
指定キーの変更内容をディスクへ書き込む。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR RegFlushKey(
    HKEY hKey
);

パラメーター

名前方向説明
hKeyHKEYin

開いているレジストリキーへのハンドル。このキーは KEY_QUERY_VALUE アクセス権で開かれている必要があります。詳細については、 Registry Key Security and Access Rights を参照してください。

このハンドルは、 RegCreateKeyExRegCreateKeyTransactedRegOpenKeyEx、または RegOpenKeyTransacted 関数によって返されます。また、次のいずれかの 定義済みキーにすることもできます。

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_PERFORMANCE_DATA
HKEY_USERS

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された開いているレジストリキーのすべての属性をレジストリに書き込みます。

戻り値

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

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

解説(Remarks)

RegFlushKey の呼び出しはコストの高い操作であり、ディスク帯域幅を消費し、フラッシュ操作が完了するまでフラッシュ対象のレジストリハイブ内のすべてのキーに対するすべてのプロセスからの変更をブロックするため、システム全体のパフォーマンスに大きく影響します。RegFlushKey は、変更直後にレジストリの変更がディスクに確実に永続化されることをアプリケーションが保証しなければならない場合にのみ、明示的に呼び出すべきです。キーに対するすべての変更は、ディスクにフラッシュしなくても他のプロセスから参照できます。

また、レジストリには 'lazy flush'(遅延フラッシュ)メカニズムがあり、一定の時間間隔でレジストリの変更をディスクにフラッシュします。この通常のフラッシュ操作に加えて、レジストリの変更はシステムのシャットダウン時にもディスクにフラッシュされます。'lazy flush' によってレジストリの変更をフラッシュさせるのが、ディスク上のレジストリストアへの書き込みを管理する最も効率的な方法です。

RegFlushKey 関数は、指定されたキーを含むハイブのすべてのデータがディスク上のレジストリストアに書き込まれた場合にのみ戻ります。

RegFlushKey 関数は、前回の遅延フラッシュまたはシステム開始以降に変更された、ハイブ内の他のキーのデータも書き出します。

RegFlushKey が戻った後、RegCloseKey を使用してレジストリキーへのハンドルを閉じてください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RegFlushKey(
    HKEY hKey
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint RegFlushKey(
    IntPtr hKey   // HKEY
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function RegFlushKey(
    hKey As IntPtr   ' HKEY
) As UInteger
End Function
' hKey : HKEY
Declare PtrSafe Function RegFlushKey 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

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

lib = Fiddle.dlopen('ADVAPI32.dll')
RegFlushKey = Fiddle::Function.new(
  lib['RegFlushKey'],
  [
    Fiddle::TYPE_VOIDP,  # hKey : HKEY
  ],
  -Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn RegFlushKey(
        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 RegFlushKey(IntPtr hKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_RegFlushKey' -Namespace Win32 -PassThru
# $api::RegFlushKey(hKey)
#uselib "ADVAPI32.dll"
#func global RegFlushKey "RegFlushKey" sptr
; RegFlushKey hKey   ; 戻り値は stat
; hKey : HKEY -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global RegFlushKey "RegFlushKey" sptr
; res = RegFlushKey(hKey)
; hKey : HKEY -> "sptr"
; WIN32_ERROR RegFlushKey(HKEY hKey)
#uselib "ADVAPI32.dll"
#cfunc global RegFlushKey "RegFlushKey" intptr
; res = RegFlushKey(hKey)
; hKey : HKEY -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegFlushKey = advapi32.NewProc("RegFlushKey")
)

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

extern "advapi32" fn RegFlushKey(
    hKey: ?*anyopaque // HKEY
) callconv(std.os.windows.WINAPI) u32;
proc RegFlushKey(
    hKey: pointer  # HKEY
): uint32 {.importc: "RegFlushKey", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint RegFlushKey(
    void* hKey   // HKEY
);
ccall((:RegFlushKey, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid},),
      hKey)
# hKey : HKEY -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RegFlushKey(
    void* hKey);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.RegFlushKey(hKey)
-- hKey : HKEY
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const RegFlushKey = lib.func('__stdcall', 'RegFlushKey', 'uint32_t', ['void *']);
// RegFlushKey(hKey)
// hKey : HKEY -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  RegFlushKey: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.RegFlushKey(hKey)
// hKey : HKEY -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RegFlushKey(
    void* hKey);
C, "ADVAPI32.dll");
// $ffi->RegFlushKey(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 RegFlushKey(
        Pointer hKey   // HKEY
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun RegFlushKey = RegFlushKey(
    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 RegFlushKeyNative = Uint32 Function(Pointer<Void>);
typedef RegFlushKeyDart = int Function(Pointer<Void>);
final RegFlushKey = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegFlushKeyNative, RegFlushKeyDart>('RegFlushKey');
// hKey : HKEY -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegFlushKey(
  hKey: THandle   // HKEY
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegFlushKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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