ホーム › System.Memory › HeapQueryInformation

HeapQueryInformation

関数

ヒープの動作に関する情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL HeapQueryInformation(
    HANDLE HeapHandle,   // optional
    HEAP_INFORMATION_CLASS HeapInformationClass,
    void* HeapInformation,   // optional
    UINT_PTR HeapInformationLength,
    UINT_PTR* ReturnLength   // optional
);

パラメーター

名前

型

方向

説明

HeapHandle

HANDLE

inoptional

情報を取得するヒープへのハンドルです。このハンドルは、 HeapCreate 関数または GetProcessHeap 関数によって返されます。

HeapInformationClass

HEAP_INFORMATION_CLASS

取得する情報のクラスです。このパラメーターには、HEAP_INFORMATION_CLASS 列挙型の次の値を指定できます。

値

意味

HeapCompatibilityInformation
0

有効になっているヒープの機能を示します。

HeapInformation パラメーターは ULONG 変数へのポインターです。

HeapInformation が 0 の場合、ヒープはルックアサイドリストをサポートしない標準ヒープです。

HeapInformation が 1 の場合、ヒープはルックアサイドリストをサポートします。詳細については「解説」を参照してください。

HeapInformation が 2 の場合、そのヒープに対して低断片化ヒープ (LFH) が有効になっています。LFH を有効にすると、ルックアサイドリストは無効になります。

HeapInformation

void*

outoptional

ヒープ情報を受け取るバッファーへのポインターです。このデータの形式は、HeapInformationClass パラメーターの値によって異なります。

HeapInformationLength

UINT_PTR

照会するヒープ情報のサイズ (バイト単位) です。

ReturnLength

UINT_PTR*

outoptional

HeapInformation バッファーに書き込まれたデータの長さを受け取る変数へのポインターです。バッファーが小さすぎる場合、関数は失敗し、ReturnLength にはバッファーに必要な最小サイズが格納されます。

この情報を受け取る必要がない場合は、NULL を指定します。

戻り値の型: BOOL

公式ドキュメント

指定されたヒープに関する情報を取得します。

戻り値

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

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

解説(Remarks)

LFH または破損時終了 (terminate-on-corruption) 機能を有効にするには、 HeapSetInformation 関数を使用します。

Windows XP および Windows Server 2003: ルックアサイドリストは、固定サイズのブロックのみを含む高速なメモリ割り当て機構です。ルックアサイドリストは、それをサポートするヒープでは既定で有効になっています。Windows Vista 以降では、ルックアサイドリストは使用されず、既定で LFH が有効になります。

ルックアサイドリストは、サイズが可変な一般的なプール割り当てよりも高速です。これは、システムが割り当てに適合する空きメモリを検索しないためです。さらに、ルックアサイドリストへのアクセスは、一般にミューテックスやスピンロックではなく、高速なアトミックプロセッサ交換命令を使用して同期されます。ルックアサイドリストは、システムまたはドライバーによって作成できます。これらは、ページプールまたは非ページプールから割り当てることができます。

例

次の例では、GetProcessHeap を使用して既定のプロセスヒープへのハンドルを取得し、 HeapQueryInformation を使用してヒープに関する情報を取得します。

#include <windows.h>
#include <tchar.h>
#include <stdio.h>

#define HEAP_STANDARD 0
#define HEAP_LAL 1
#define HEAP_LFH 2

int __cdecl _tmain()
{
    BOOL bResult;
    HANDLE hHeap;
    ULONG HeapInformation;

    //
    // Get a handle to the default process heap.
    //
    hHeap = GetProcessHeap();
    if (hHeap == NULL) {
        _tprintf(TEXT("Failed to retrieve default process heap with LastError %d.\n"),
                 GetLastError());
        return 1;
    }

    //
    // Query heap features that are enabled.
    //
    bResult = HeapQueryInformation(hHeap,
                                   HeapCompatibilityInformation,
                                   &HeapInformation,
                                   sizeof(HeapInformation),
                                   NULL);
    if (bResult == FALSE) {
        _tprintf(TEXT("Failed to retrieve heap features with LastError %d.\n"),
                 GetLastError());
        return 1;
    }

    //
    // Print results of the query.
    //
    _tprintf(TEXT("HeapCompatibilityInformation is %d.\n"), HeapInformation);
    switch(HeapInformation)
    {
    case HEAP_STANDARD:
        _tprintf(TEXT("The default process heap is a standard heap.\n"));
        break;
    case HEAP_LAL:
        _tprintf(TEXT("The default process heap supports look-aside lists.\n"));
        break;
    case HEAP_LFH:
        _tprintf(TEXT("The default process heap has the low-fragmentation ") \
                 TEXT("heap enabled.\n"));
        break;
    default:
        _tprintf(TEXT("Unrecognized HeapInformation reported for the default ") \
                 TEXT("process heap.\n"));
        break;
     }

    return 0;
}

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

各言語での呼び出し定義

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

BOOL HeapQueryInformation(
    HANDLE HeapHandle,   // optional
    HEAP_INFORMATION_CLASS HeapInformationClass,
    void* HeapInformation,   // optional
    UINT_PTR HeapInformationLength,
    UINT_PTR* ReturnLength   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool HeapQueryInformation(
    IntPtr HeapHandle,   // HANDLE optional
    int HeapInformationClass,   // HEAP_INFORMATION_CLASS
    IntPtr HeapInformation,   // void* optional, out
    UIntPtr HeapInformationLength,   // UINT_PTR
    IntPtr ReturnLength   // UINT_PTR* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HeapQueryInformation(
    HeapHandle As IntPtr,   ' HANDLE optional
    HeapInformationClass As Integer,   ' HEAP_INFORMATION_CLASS
    HeapInformation As IntPtr,   ' void* optional, out
    HeapInformationLength As UIntPtr,   ' UINT_PTR
    ReturnLength As IntPtr   ' UINT_PTR* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' HeapHandle : HANDLE optional
' HeapInformationClass : HEAP_INFORMATION_CLASS
' HeapInformation : void* optional, out
' HeapInformationLength : UINT_PTR
' ReturnLength : UINT_PTR* optional, out
Declare PtrSafe Function HeapQueryInformation Lib "kernel32" ( _
    ByVal HeapHandle As LongPtr, _
    ByVal HeapInformationClass As Long, _
    ByVal HeapInformation As LongPtr, _
    ByVal HeapInformationLength As LongPtr, _
    ByVal ReturnLength As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HeapQueryInformation = ctypes.windll.kernel32.HeapQueryInformation
HeapQueryInformation.restype = wintypes.BOOL
HeapQueryInformation.argtypes = [
    wintypes.HANDLE,  # HeapHandle : HANDLE optional
    ctypes.c_int,  # HeapInformationClass : HEAP_INFORMATION_CLASS
    ctypes.POINTER(None),  # HeapInformation : void* optional, out
    ctypes.c_size_t,  # HeapInformationLength : UINT_PTR
    ctypes.POINTER(ctypes.c_size_t),  # ReturnLength : UINT_PTR* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
HeapQueryInformation = Fiddle::Function.new(
  lib['HeapQueryInformation'],
  [
    Fiddle::TYPE_VOIDP,  # HeapHandle : HANDLE optional
    Fiddle::TYPE_INT,  # HeapInformationClass : HEAP_INFORMATION_CLASS
    Fiddle::TYPE_VOIDP,  # HeapInformation : void* optional, out
    Fiddle::TYPE_UINTPTR_T,  # HeapInformationLength : UINT_PTR
    Fiddle::TYPE_VOIDP,  # ReturnLength : UINT_PTR* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn HeapQueryInformation(
        HeapHandle: *mut core::ffi::c_void,  // HANDLE optional
        HeapInformationClass: i32,  // HEAP_INFORMATION_CLASS
        HeapInformation: *mut (),  // void* optional, out
        HeapInformationLength: usize,  // UINT_PTR
        ReturnLength: *mut usize  // UINT_PTR* optional, out
    ) -> 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 HeapQueryInformation(IntPtr HeapHandle, int HeapInformationClass, IntPtr HeapInformation, UIntPtr HeapInformationLength, IntPtr ReturnLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapQueryInformation' -Namespace Win32 -PassThru
# $api::HeapQueryInformation(HeapHandle, HeapInformationClass, HeapInformation, HeapInformationLength, ReturnLength)

#uselib "KERNEL32.dll"
#func global HeapQueryInformation "HeapQueryInformation" sptr, sptr, sptr, sptr, sptr
; HeapQueryInformation HeapHandle, HeapInformationClass, HeapInformation, HeapInformationLength, varptr(ReturnLength)   ; 戻り値は stat
; HeapHandle : HANDLE optional -> "sptr"
; HeapInformationClass : HEAP_INFORMATION_CLASS -> "sptr"
; HeapInformation : void* optional, out -> "sptr"
; HeapInformationLength : UINT_PTR -> "sptr"
; ReturnLength : UINT_PTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global HeapQueryInformation "HeapQueryInformation" sptr, int, sptr, sptr, var
; res = HeapQueryInformation(HeapHandle, HeapInformationClass, HeapInformation, HeapInformationLength, ReturnLength)
; HeapHandle : HANDLE optional -> "sptr"
; HeapInformationClass : HEAP_INFORMATION_CLASS -> "int"
; HeapInformation : void* optional, out -> "sptr"
; HeapInformationLength : UINT_PTR -> "sptr"
; ReturnLength : UINT_PTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global HeapQueryInformation "HeapQueryInformation" sptr, int, sptr, sptr, sptr
; res = HeapQueryInformation(HeapHandle, HeapInformationClass, HeapInformation, HeapInformationLength, varptr(ReturnLength))
; HeapHandle : HANDLE optional -> "sptr"
; HeapInformationClass : HEAP_INFORMATION_CLASS -> "int"
; HeapInformation : void* optional, out -> "sptr"
; HeapInformationLength : UINT_PTR -> "sptr"
; ReturnLength : UINT_PTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。