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

HeapCompact

関数
ヒープの空き領域を結合し最大空きブロックを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

UINT_PTR HeapCompact(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags
);

パラメーター

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

ヒープアクセスのオプション。このパラメーターには次の値を指定できます。

意味
HEAP_NO_SERIALIZE
0x00000001
シリアル化アクセスは使用されません。

詳細については「解説」を参照してください。

この関数へのすべての呼び出しでシリアル化アクセスを確実に無効にするには、HeapCreate の呼び出しで HEAP_NO_SERIALIZE を指定します。この場合、この関数の呼び出しで HEAP_NO_SERIALIZE を追加で指定する必要はありません。

プロセスヒープにアクセスするときにはこの値を指定しないでください。システムは、CTRL+C ハンドラーなど、プロセスヒープに同時にアクセスする追加のスレッドをアプリケーションのプロセス内に作成する場合があります。

戻り値の型: UINT_PTR

公式ドキュメント

指定したヒープ内で最大のコミット済み空きブロックのサイズを返します。Disable heap coalesce on free グローバルフラグが設定されている場合、この関数はヒープ内の隣接する空きメモリブロックの結合も行います。

戻り値

関数が成功すると、戻り値はヒープ内で最大のコミット済み空きブロックのサイズ(バイト単位)です。

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

ヒープに空き領域がまったく存在しないというまれなケースでは、関数の戻り値は 0 となり、GetLastError は値 NO_ERROR を返します。

解説(Remarks)

HeapCompact 関数は主にデバッグに役立ちます。通常、システムは HeapFree 関数が呼び出されるたびにヒープを圧縮し、HeapCompact 関数はヒープ内で最大の空きブロックのサイズを返しますが、それ以上のヒープ圧縮は行いません。デバッグ中に Disable heap coalesce on free グローバルフラグが設定されている場合、システムはヒープを圧縮せず、HeapCompact 関数を呼び出すとヒープが圧縮されます。グローバルフラグの詳細については、GFlags のドキュメントを参照してください。

アプリケーションが HeapCompact によって返されたサイズのメモリブロックを正常に割り当てられる保証はありません。他のスレッドやコミットしきい値により、そのような割り当てが妨げられる場合があります。

シリアル化は、2 つ以上のスレッドが同じヒープからブロックを同時に割り当てまたは解放しようとする場合に相互排他を保証します。シリアル化にはわずかなパフォーマンスコストがありますが、複数のスレッドが同じヒープからメモリを割り当て・解放する場合には必ず使用する必要があります。HEAP_NO_SERIALIZE 値を設定すると、ヒープに対する相互排他が無効になります。シリアル化を行わないと、同じヒープハンドルを使用する 2 つ以上のスレッドが同時にメモリを割り当てまたは解放しようとし、ヒープの破損を引き起こす可能性が高くなります。したがって、HEAP_NO_SERIALIZE 値を安全に使用できるのは次の状況に限られます。

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

各言語での呼び出し定義

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

UINT_PTR HeapCompact(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern UIntPtr HeapCompact(
    IntPtr hHeap,   // HANDLE
    uint dwFlags   // HEAP_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HeapCompact(
    hHeap As IntPtr,   ' HANDLE
    dwFlags As UInteger   ' HEAP_FLAGS
) As UIntPtr
End Function
' hHeap : HANDLE
' dwFlags : HEAP_FLAGS
Declare PtrSafe Function HeapCompact Lib "kernel32" ( _
    ByVal hHeap As LongPtr, _
    ByVal dwFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapCompact = kernel32.NewProc("HeapCompact")
)

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

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

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

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

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

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

関連項目

使用する型