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

HeapCreate

関数
プライベートヒープオブジェクトを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

HANDLE HeapCreate(
    HEAP_FLAGS flOptions,
    UINT_PTR dwInitialSize,
    UINT_PTR dwMaximumSize
);

パラメーター

名前方向説明
flOptionsHEAP_FLAGSin

ヒープの割り当てオプション。これらのオプションは、ヒープ関数の呼び出しを通じた新しいヒープへの以降のアクセスに影響します。このパラメーターには 0、または次の値の 1 つ以上を指定できます。

Value Meaning
HEAP_CREATE_ENABLE_EXECUTE
0x00040000
ハードウェアがデータ実行防止を強制する場合、このヒープから割り当てられるすべてのメモリブロックでコードの実行が許可されます。ヒープからコードを実行するアプリケーションでは、このフラグを使用してください。HEAP_CREATE_ENABLE_EXECUTE が指定されておらず、アプリケーションが保護されたページからコードを実行しようとした場合、アプリケーションはステータスコード STATUS_ACCESS_VIOLATION の例外を受け取ります。
HEAP_GENERATE_EXCEPTIONS
0x00000004
HeapAlloc および HeapReAlloc の呼び出しに対して、システムは NULL を返す代わりに、失敗(たとえばメモリ不足の状態)を示す例外を発生させます。
HEAP_NO_SERIALIZE
0x00000001
ヒープ関数がこのヒープにアクセスする際に、シリアル化されたアクセスは使用されません。このオプションは、以降のすべてのヒープ関数の呼び出しに適用されます。あるいは、個々のヒープ関数の呼び出しでこのオプションを指定することもできます。

このオプションで作成されたヒープでは、ロックされていないフラグメンテーションヒープ(LFH)を有効にできません。

このオプションで作成されたヒープはロックできません。

シリアル化されたアクセスの詳細については、このトピックの「解説」セクションを参照してください。

dwInitialSizeUINT_PTRin

ヒープの初期サイズ(バイト単位)。この値は、ヒープに対して最初にコミットされるメモリ量を決定します。値はシステムのページサイズの倍数に切り上げられます。値は dwMaximumSize より小さくなければなりません。

このパラメーターが 0 の場合、関数は 1 ページをコミットします。ホストコンピューター上のページサイズを調べるには、GetSystemInfo 関数を使用してください。

dwMaximumSizeUINT_PTRin

ヒープの最大サイズ(バイト単位)。HeapCreate 関数は dwMaximumSize をシステムのページサイズの倍数に切り上げ、そのサイズのブロックをヒープ用にプロセスの仮想アドレス空間に予約します。HeapAlloc または HeapReAlloc 関数による割り当て要求が dwInitialSize で指定されたサイズを超える場合、システムはヒープの最大サイズまで、ヒープに対して追加のメモリページをコミットします。

dwMaximumSize が 0 でない場合、ヒープサイズは固定され、最大サイズを超えて拡大することはできません。また、ヒープから割り当て可能な最大のメモリブロックは、32 ビットプロセスでは 512 KB をわずかに下回り、64 ビットプロセスでは 1,024 KB をわずかに下回ります。これより大きなブロックの割り当て要求は、ヒープの最大サイズがそのブロックを格納するのに十分大きい場合でも失敗します。

dwMaximumSize が 0 の場合、ヒープはサイズを拡大できます。ヒープのサイズは利用可能なメモリによってのみ制限されます。固定サイズヒープの上限より大きなメモリブロックの割り当て要求は自動的には失敗しません。代わりに、システムは大きなブロックに必要なメモリを取得するために VirtualAlloc 関数を呼び出します。大きなメモリブロックを割り当てる必要があるアプリケーションは、dwMaximumSize を 0 に設定してください。

戻り値の型: HANDLE

公式ドキュメント

呼び出し元プロセスが使用できるプライベートヒープオブジェクトを作成します。この関数は、プロセスの仮想アドレス空間に領域を予約し、このブロックのうち指定された初期部分に対して物理ストレージを割り当てます。

戻り値

関数が成功した場合、戻り値は新しく作成されたヒープへのハンドルです。

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

解説(Remarks)

HeapCreate 関数は、呼び出し元プロセスが HeapAlloc 関数を使用してメモリブロックを割り当てることができる、プライベートヒープオブジェクトを作成します。初期サイズは、ヒープに対して最初に割り当てられるコミット済みページ数を決定します。最大サイズは、予約されるページの総数を決定します。これらのページは、ヒープが拡大できるブロックをプロセスの仮想アドレス空間内に作成します。HeapAlloc による要求がコミット済みページの現在のサイズを超える場合、物理ストレージが利用可能であれば、この予約済み領域から追加のページが自動的にコミットされます。

Windows Server 2003 および Windows XP: 既定では、新しく作成されたプライベートヒープは標準ヒープです。ロックされていないフラグメンテーションヒープを有効にするには、プライベートヒープへのハンドルを指定して HeapSetInformation 関数を呼び出してください。

プライベートヒープオブジェクトのメモリは、それを作成したプロセスのみがアクセスできます。ダイナミックリンクライブラリ(DLL)がプライベートヒープを作成する場合、ヒープはその DLL を呼び出すプロセスのアドレス空間に作成され、そのプロセスのみがアクセスできます。

システムはヒープサポート構造を格納するためにプライベートヒープのメモリを使用するため、指定したヒープサイズのすべてがプロセスで利用できるわけではありません。たとえば、HeapAlloc 関数が最大サイズ 64 キロバイト(K)のヒープから 64K を要求した場合、システムのオーバーヘッドのために要求が失敗することがあります。

HEAP_NO_SERIALIZE が指定されていない場合(単純な既定の動作)、ヒープは呼び出し元プロセス内でアクセスをシリアル化します。シリアル化により、2 つ以上のスレッドが同じヒープから同時にブロックを割り当てまたは解放しようとしたときに、相互排他が保証されます。シリアル化にはわずかなパフォーマンスコストが伴いますが、複数のスレッドが同じヒープからメモリを割り当てたり解放したりする場合は常に使用しなければなりません。HeapLock 関数および HeapUnlock 関数を使用して、シリアル化されたヒープへのアクセスをブロックしたり許可したりできます。

HEAP_NO_SERIALIZE を設定すると、ヒープ上の相互排他が無効になります。シリアル化を行わない場合、同じヒープハンドルを使用する 2 つ以上のスレッドが同時にメモリを割り当てまたは解放しようとし、ヒープが破損する可能性があります。したがって、HEAP_NO_SERIALIZE は次の状況でのみ安全に使用できます。

HEAP_NO_SERIALIZE フラグを指定して作成されたヒープに対して HeapLock 関数および HeapUnlock 関数を呼び出した場合、結果は未定義です。

プロセスの既定ヒープへのハンドルを取得するには、GetProcessHeap 関数を使用してください。呼び出し元プロセスでアクティブな既定ヒープおよびプライベートヒープへのハンドルを取得するには、GetProcessHeaps 関数を使用してください。

ヒープの列挙

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

各言語での呼び出し定義

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

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

HeapCreate = ctypes.windll.kernel32.HeapCreate
HeapCreate.restype = ctypes.c_void_p
HeapCreate.argtypes = [
    wintypes.DWORD,  # flOptions : HEAP_FLAGS
    ctypes.c_size_t,  # dwInitialSize : UINT_PTR
    ctypes.c_size_t,  # dwMaximumSize : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapCreate = kernel32.NewProc("HeapCreate")
)

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

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

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

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

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

(cffi:defcfun ("HeapCreate" heap-create :convention :stdcall) :pointer
  (fl-options :uint32)   ; HEAP_FLAGS
  (dw-initial-size :uint64)   ; UINT_PTR
  (dw-maximum-size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HeapCreate = Win32::API::More->new('KERNEL32',
    'HANDLE HeapCreate(DWORD flOptions, WPARAM dwInitialSize, WPARAM dwMaximumSize)');
# my $ret = $HeapCreate->Call($flOptions, $dwInitialSize, $dwMaximumSize);
# flOptions : HEAP_FLAGS -> DWORD
# dwInitialSize : UINT_PTR -> WPARAM
# dwMaximumSize : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型