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

HeapFree

関数
ヒープに割り当てたメモリブロックを解放する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL HeapFree(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags,
    void* lpMem   // optional
);

パラメーター

名前方向説明
hHeapHANDLEinoutメモリブロックを解放するヒープへのハンドル。このハンドルは HeapCreate 関数または GetProcessHeap 関数によって返されます。
dwFlagsHEAP_FLAGSin

ヒープ解放のオプション。次の値を指定すると、HeapCreate 関数によってヒープを作成した際に flOptions パラメーターで指定した対応する値が上書きされます。

意味
HEAP_NO_SERIALIZE
0x00000001
シリアル化されたアクセスは使用されません。詳細については「解説」を参照してください。

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

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

lpMemvoid*inoptional解放するメモリブロックへのポインター。このポインターは HeapAlloc 関数または HeapReAlloc 関数によって返されます。このポインターは NULL でもかまいません。

戻り値の型: BOOL

公式ドキュメント

HeapAlloc 関数または HeapReAlloc 関数によってヒープから割り当てられたメモリブロックを解放します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。アプリケーションは GetLastError を呼び出すことで、拡張エラー情報を取得できます。

解説(Remarks)

HeapFree によって解放されたメモリは、いかなる方法でも参照しないでください。メモリが解放された後は、そこに格納されていた情報は永久に失われます。情報が必要な場合は、その情報を含むメモリを解放しないでください。メモリに関する情報を返す関数呼び出し(HeapSize など)は、不正なデータを返す可能性があるため、解放済みのメモリに対して使用しないでください。同じポインターで HeapFree を 2 回呼び出すと、ヒープの破損を引き起こし、その後の HeapAlloc の呼び出しが同じポインターを 2 回返す原因となることがあります。

シリアル化により、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>

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

HeapFree = ctypes.windll.kernel32.HeapFree
HeapFree.restype = wintypes.BOOL
HeapFree.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE in/out
    wintypes.DWORD,  # dwFlags : HEAP_FLAGS
    ctypes.POINTER(None),  # lpMem : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
HeapFree = Fiddle::Function.new(
  lib['HeapFree'],
  [
    Fiddle::TYPE_VOIDP,  # hHeap : HANDLE in/out
    -Fiddle::TYPE_INT,  # dwFlags : HEAP_FLAGS
    Fiddle::TYPE_VOIDP,  # lpMem : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn HeapFree(
        hHeap: *mut core::ffi::c_void,  // HANDLE in/out
        dwFlags: u32,  // HEAP_FLAGS
        lpMem: *mut ()  // void* optional
    ) -> 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 HeapFree(IntPtr hHeap, uint dwFlags, IntPtr lpMem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapFree' -Namespace Win32 -PassThru
# $api::HeapFree(hHeap, dwFlags, lpMem)
#uselib "KERNEL32.dll"
#func global HeapFree "HeapFree" sptr, sptr, sptr
; HeapFree hHeap, dwFlags, lpMem   ; 戻り値は stat
; hHeap : HANDLE in/out -> "sptr"
; dwFlags : HEAP_FLAGS -> "sptr"
; lpMem : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global HeapFree "HeapFree" sptr, int, sptr
; res = HeapFree(hHeap, dwFlags, lpMem)
; hHeap : HANDLE in/out -> "sptr"
; dwFlags : HEAP_FLAGS -> "int"
; lpMem : void* optional -> "sptr"
; BOOL HeapFree(HANDLE hHeap, HEAP_FLAGS dwFlags, void* lpMem)
#uselib "KERNEL32.dll"
#cfunc global HeapFree "HeapFree" intptr, int, intptr
; res = HeapFree(hHeap, dwFlags, lpMem)
; hHeap : HANDLE in/out -> "intptr"
; dwFlags : HEAP_FLAGS -> "int"
; lpMem : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapFree = kernel32.NewProc("HeapFree")
)

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

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

typedef HeapFreeNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef HeapFreeDart = int Function(Pointer<Void>, int, Pointer<Void>);
final HeapFree = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<HeapFreeNative, HeapFreeDart>('HeapFree');
// hHeap : HANDLE in/out -> Pointer<Void>
// dwFlags : HEAP_FLAGS -> Uint32
// lpMem : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HeapFree(
  hHeap: THandle;   // HANDLE in/out
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'HeapFree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HeapFree"
  c_HeapFree :: Ptr () -> Word32 -> Ptr () -> IO CInt
-- hHeap : HANDLE in/out -> Ptr ()
-- dwFlags : HEAP_FLAGS -> Word32
-- lpMem : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

使用する型