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

GetProcessHeaps

関数
プロセス内の全ヒープのハンドルを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetProcessHeaps(
    DWORD NumberOfHeaps,
    HANDLE* ProcessHeaps
);

パラメーター

名前方向説明
NumberOfHeapsDWORDinProcessHeaps が指すバッファーに格納できるヒープハンドルの最大数です。
ProcessHeapsHANDLE*outヒープハンドルの配列を受け取るバッファーへのポインターです。

戻り値の型: DWORD

公式ドキュメント

アクティブなヒープの数を返し、呼び出し元プロセスのすべてのアクティブなヒープへのハンドルを取得します。

戻り値

戻り値は、呼び出し元プロセスでアクティブなヒープへのハンドルの数です。

戻り値が NumberOfHeaps 以下の場合、関数はその数のヒープハンドルを ProcessHeaps が指すバッファーに格納しています。

戻り値が NumberOfHeaps より大きい場合、ProcessHeaps が指すバッファーは呼び出し元プロセスのすべてのヒープハンドルを保持するには小さすぎ、関数は NumberOfHeaps 個のハンドルをバッファーに格納します。戻り値を使用してすべてのハンドルを受け取るのに十分な大きさのバッファーを割り当て、関数を再度呼び出してください。

戻り値が 0 の場合、関数は失敗しています。すべてのプロセスは少なくとも 1 つのアクティブなヒープ(プロセスの既定のヒープ)を持つためです。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

GetProcessHeaps 関数は、呼び出し元プロセスの既定のヒープへのハンドルに加えて、プロセス内の任意のスレッドで HeapCreate 関数を呼び出して作成された追加のプライベートヒープへのハンドルを取得します。

GetProcessHeaps 関数は主にデバッグに役立ちます。なぜなら、この関数で取得されるプライベートヒープの一部は、プロセス内で実行されている他のコードによって作成された可能性があり、GetProcessHeaps が戻った後に破棄される場合があるためです。ヒープを破棄するとそのヒープへのハンドルが無効になり、そのようなハンドルを使用し続けると、アプリケーションで未定義の動作が発生する可能性があります。ヒープ関数は、呼び出し元プロセスの既定のヒープ、およびプロセスが作成して管理するプライベートヒープに対してのみ呼び出すべきです。

呼び出し元プロセスのプロセスヒープへのハンドルを取得するには、GetProcessHeap 関数を使用してください。

例については、Getting Process Heaps を参照してください。

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

各言語での呼び出し定義

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

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

GetProcessHeaps = ctypes.windll.kernel32.GetProcessHeaps
GetProcessHeaps.restype = wintypes.DWORD
GetProcessHeaps.argtypes = [
    wintypes.DWORD,  # NumberOfHeaps : DWORD
    ctypes.c_void_p,  # ProcessHeaps : HANDLE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetProcessHeaps = kernel32.NewProc("GetProcessHeaps")
)

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

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

typedef GetProcessHeapsNative = Uint32 Function(Uint32, Pointer<Void>);
typedef GetProcessHeapsDart = int Function(int, Pointer<Void>);
final GetProcessHeaps = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetProcessHeapsNative, GetProcessHeapsDart>('GetProcessHeaps');
// NumberOfHeaps : DWORD -> Uint32
// ProcessHeaps : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetProcessHeaps(
  NumberOfHeaps: DWORD;   // DWORD
  ProcessHeaps: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetProcessHeaps';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetProcessHeaps"
  c_GetProcessHeaps :: Word32 -> Ptr () -> IO Word32
-- NumberOfHeaps : DWORD -> Word32
-- ProcessHeaps : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetProcessHeaps" get-process-heaps :convention :stdcall) :uint32
  (number-of-heaps :uint32)   ; DWORD
  (process-heaps :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetProcessHeaps = Win32::API::More->new('KERNEL32',
    'DWORD GetProcessHeaps(DWORD NumberOfHeaps, HANDLE ProcessHeaps)');
# my $ret = $GetProcessHeaps->Call($NumberOfHeaps, $ProcessHeaps);
# NumberOfHeaps : DWORD -> DWORD
# ProcessHeaps : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。