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

HeapValidate

関数
ヒープまたはメモリブロックの整合性を検証する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

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

パラメーター

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

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

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

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

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

lpMemvoid*inoptional

指定されたヒープ内のメモリブロックへのポインターです。このパラメーターには NULL を指定できます。

このパラメーターが NULL の場合、関数は hHeap で指定されたヒープ全体の検証を試みます。

このパラメーターが NULL でない場合、関数は lpMem が指すメモリブロックの検証を試みます。ヒープの残りの部分の検証は試みません。

戻り値の型: BOOL

公式ドキュメント

指定されたヒープを検証します。この関数はヒープ内のすべてのメモリブロックをスキャンし、ヒープマネージャーが管理するヒープ制御構造体が整合性のとれた状態にあることを確認します。

戻り値

指定されたヒープまたはメモリブロックが有効な場合、戻り値は 0 以外になります。

指定されたヒープまたはメモリブロックが無効な場合、戻り値は 0 になります。デバッグ用に構成されたシステムでは、 HeapValidate 関数は、ヒープまたはメモリブロックの無効な部分を説明するデバッグメッセージを表示し、ハードコードされたブレークポイントで停止するため、システムを調べて無効性の原因を特定できます。 HeapValidate 関数はスレッドの最終エラー値を設定しません。この関数には拡張エラー情報がないため、GetLastError を呼び出さないでください。

解説(Remarks)

HeapValidate 関数は、検証に時間がかかる可能性があるため、主にデバッグに役立ちます。ヒープの検証は他のスレッドによるヒープへのアクセスをブロックし、特に対称型マルチプロセッシング (SMP) コンピューターでパフォーマンスを低下させる可能性があります。これらの副作用は HeapValidate が返るまで続くことがあります。

ヒープには、ヒープ内の各メモリブロックに対する制御構造体と、ヒープ全体に対する制御構造体があります。 HeapValidate 関数を使用してヒープ全体を検証する場合、これらすべての制御構造体の整合性を確認します。

HeapValidate を使用してヒープ内の単一のメモリブロックを検証する場合、その要素に関連する制御構造体のみを確認します。 HeapValidate は割り当て済みのメモリブロックのみを検証できます。解放済みのメモリブロックに対して HeapValidate を呼び出すと、検証する制御構造体がないため FALSE を返します。

HeapWalk 関数によって列挙されたヒープ要素を検証する場合は、 PROCESS_HEAP_ENTRY 構造体の wFlags メンバーに PROCESS_HEAP_ENTRY_BUSY が設定されている要素に対してのみ HeapValidate を呼び出す必要があります。 HeapValidate は、このビットが設定されていないすべてのヒープ要素に対して FALSE を返します。

シリアル化は、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 HeapValidate(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags,
    const void* lpMem   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool HeapValidate(
    IntPtr hHeap,   // HANDLE
    uint dwFlags,   // HEAP_FLAGS
    IntPtr lpMem   // void* optional
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function HeapValidate(
    hHeap As IntPtr,   ' HANDLE
    dwFlags As UInteger,   ' HEAP_FLAGS
    lpMem As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hHeap : HANDLE
' dwFlags : HEAP_FLAGS
' lpMem : void* optional
Declare PtrSafe Function HeapValidate 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

HeapValidate = ctypes.windll.kernel32.HeapValidate
HeapValidate.restype = wintypes.BOOL
HeapValidate.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE
    wintypes.DWORD,  # dwFlags : HEAP_FLAGS
    ctypes.POINTER(None),  # lpMem : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapValidate = kernel32.NewProc("HeapValidate")
)

// hHeap (HANDLE), dwFlags (HEAP_FLAGS), lpMem (void* optional)
r1, _, err := procHeapValidate.Call(
	uintptr(hHeap),
	uintptr(dwFlags),
	uintptr(lpMem),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function HeapValidate(
  hHeap: THandle;   // HANDLE
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'HeapValidate';
result := DllCall("KERNEL32\HeapValidate"
    , "Ptr", hHeap   ; HANDLE
    , "UInt", dwFlags   ; HEAP_FLAGS
    , "Ptr", lpMem   ; void* optional
    , "Int")   ; return: BOOL
●HeapValidate(hHeap, dwFlags, lpMem) = DLL("KERNEL32.dll", "bool HeapValidate(void*, dword, void*)")
# 呼び出し: HeapValidate(hHeap, dwFlags, lpMem)
# hHeap : HANDLE -> "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 HeapValidate(
    hHeap: ?*anyopaque, // HANDLE
    dwFlags: u32, // HEAP_FLAGS
    lpMem: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc HeapValidate(
    hHeap: pointer,  # HANDLE
    dwFlags: uint32,  # HEAP_FLAGS
    lpMem: pointer  # void* optional
): int32 {.importc: "HeapValidate", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int HeapValidate(
    void* hHeap,   // HANDLE
    uint dwFlags,   // HEAP_FLAGS
    void* lpMem   // void* optional
);
ccall((:HeapValidate, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      hHeap, dwFlags, lpMem)
# hHeap : HANDLE -> Ptr{Cvoid}
# dwFlags : HEAP_FLAGS -> UInt32
# lpMem : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HeapValidate(
    void* hHeap,
    uint32_t dwFlags,
    void* lpMem);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.HeapValidate(hHeap, dwFlags, lpMem)
-- hHeap : HANDLE
-- dwFlags : HEAP_FLAGS
-- lpMem : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const HeapValidate = lib.func('__stdcall', 'HeapValidate', 'int32_t', ['void *', 'uint32_t', 'void *']);
// HeapValidate(hHeap, dwFlags, lpMem)
// hHeap : HANDLE -> 'void *'
// dwFlags : HEAP_FLAGS -> 'uint32_t'
// lpMem : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  HeapValidate: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.HeapValidate(hHeap, dwFlags, lpMem)
// hHeap : HANDLE -> "pointer"
// dwFlags : HEAP_FLAGS -> "u32"
// lpMem : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HeapValidate(
    void* hHeap,
    uint32_t dwFlags,
    void* lpMem);
C, "KERNEL32.dll");
// $ffi->HeapValidate(hHeap, dwFlags, lpMem);
// hHeap : HANDLE
// 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 HeapValidate(
        Pointer hHeap,   // HANDLE
        int dwFlags,   // HEAP_FLAGS
        Pointer lpMem   // void* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun HeapValidate = HeapValidate(
    hHeap : Void*,   # HANDLE
    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 HeapValidateNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef HeapValidateDart = int Function(Pointer<Void>, int, Pointer<Void>);
final HeapValidate = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<HeapValidateNative, HeapValidateDart>('HeapValidate');
// hHeap : HANDLE -> Pointer<Void>
// dwFlags : HEAP_FLAGS -> Uint32
// lpMem : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HeapValidate(
  hHeap: THandle;   // HANDLE
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer   // void* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'HeapValidate';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let heapvalidate =
  foreign "HeapValidate"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hHeap : HANDLE -> (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 ("HeapValidate" heap-validate :convention :stdcall) :int32
  (h-heap :pointer)   ; HANDLE
  (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 $HeapValidate = Win32::API::More->new('KERNEL32',
    'BOOL HeapValidate(HANDLE hHeap, DWORD dwFlags, LPVOID lpMem)');
# my $ret = $HeapValidate->Call($hHeap, $dwFlags, $lpMem);
# hHeap : HANDLE -> HANDLE
# dwFlags : HEAP_FLAGS -> DWORD
# lpMem : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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