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

HeapLock

関数
ヒープを他スレッドからアクセスできないようロックする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL HeapLock(
    HANDLE hHeap
);

パラメーター

名前方向説明
hHeapHANDLEinロックするヒープへのハンドル。このハンドルは、HeapCreate 関数または GetProcessHeap 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

指定したヒープに関連付けられたクリティカルセクションオブジェクト(ロック)の取得を試みます。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

関数が成功すると、呼び出し元のスレッドがヒープロックを所有します。ヒープからメモリを割り当てたり解放したりできるのは、呼び出し元のスレッドのみです。呼び出し元プロセスの他のスレッドがヒープからメモリを割り当てまたは解放しようとすると、そのスレッドの実行はブロックされます。これらのスレッドは、ヒープロックを所有するスレッドが HeapUnlock 関数を呼び出すまでブロックされたままになります。

HeapLock 関数は主に、呼び出し元のスレッドが HeapWalk 関数を使用している間、他のスレッドによるヒープメモリの割り当てと解放を防止するのに役立ちます。

HEAP_NO_SERIALIZE フラグを指定して作成したヒープに対して HeapLock 関数を呼び出した場合、結果は未定義です。

HeapLock の成功した各呼び出しは、対応する HeapUnlock の呼び出しと対にする必要があります。HeapUnlock を呼び出さないと、ヒープへのアクセスを試みる呼び出し元プロセスの他のスレッドの実行がブロックされます。

ヒープの列挙

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

各言語での呼び出し定義

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

BOOL HeapLock(
    HANDLE hHeap
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool HeapLock(
    IntPtr hHeap   // HANDLE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HeapLock(
    hHeap As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hHeap : HANDLE
Declare PtrSafe Function HeapLock Lib "kernel32" ( _
    ByVal hHeap As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HeapLock = ctypes.windll.kernel32.HeapLock
HeapLock.restype = wintypes.BOOL
HeapLock.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapLock = kernel32.NewProc("HeapLock")
)

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

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

typedef HeapLockNative = Int32 Function(Pointer<Void>);
typedef HeapLockDart = int Function(Pointer<Void>);
final HeapLock = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<HeapLockNative, HeapLockDart>('HeapLock');
// hHeap : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HeapLock(
  hHeap: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'HeapLock';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let heaplock =
  foreign "HeapLock"
    ((ptr void) @-> returning int32_t)
(* hHeap : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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