HeapAlloc
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
void* HeapAlloc(
HANDLE hHeap,
HEAP_FLAGS dwFlags,
UINT_PTR dwBytes
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| hHeap | HANDLE | in | メモリの割り当て元となるヒープへのハンドルです。このハンドルは HeapCreate 関数または GetProcessHeap 関数によって返されます。 | ||||||||
| dwFlags | HEAP_FLAGS | in | ヒープの割り当てオプションです。これらの値のいずれかを指定すると、HeapCreate でヒープを作成した際に指定した対応する値が上書きされます。このパラメーターには、次の値を 1 つ以上指定できます。
| ||||||||
| dwBytes | UINT_PTR | in | 割り当てるバイト数です。 hHeap パラメーターで指定したヒープが「拡張不可能 (non-growable)」なヒープである場合、dwBytes は 0x7FFF8 未満でなければなりません。拡張不可能なヒープは、HeapCreate 関数を 0 以外の値で呼び出すことによって作成します。 |
戻り値の型: void*
公式ドキュメント
ヒープからメモリブロックを割り当てます。割り当てられたメモリは移動できません。
戻り値
関数が成功した場合、戻り値は割り当てられたメモリブロックへのポインターです。
関数が失敗し、かつ HEAP_GENERATE_EXCEPTIONS を指定していない場合、戻り値は NULL です。
関数が失敗し、かつ HEAP_GENERATE_EXCEPTIONS を指定している場合、関数は次の表に示すいずれかの例外を生成することがあります。発生する具体的な例外は、ヒープ破損の性質によって異なります。詳細については GetExceptionCode を参照してください。
| 例外コード | 説明 |
|---|---|
| STATUS_NO_MEMORY | 利用可能なメモリの不足またはヒープ破損のため、割り当ての試行が失敗しました。 |
| STATUS_ACCESS_VIOLATION | ヒープ破損または不適切な関数パラメーターのため、割り当ての試行が失敗しました。 |
関数が失敗しても、SetLastError は呼び出されません。アプリケーションは拡張エラー情報を得るために GetLastError を呼び出すことはできません。
解説(Remarks)
HeapAlloc 関数が成功した場合、少なくとも要求された量のメモリが割り当てられます。
プロセスの既定のヒープからメモリを割り当てるには、GetProcessHeap 関数が返すハンドルを指定して HeapAlloc を使用します。
HeapAlloc によって割り当てられたメモリブロックを解放するには、HeapFree 関数を使用します。
HeapAlloc によって割り当てられたメモリは移動できません。HeapAlloc が返すアドレスは、そのメモリブロックが解放または再割り当てされるまで有効です。メモリブロックをロックする必要はありません。システムはプライベートヒープを圧縮できないため、ヒープは断片化することがあります。
HeapAlloc が返すメモリのアラインメントは、WinNT.h における MEMORY_ALLOCATION_ALIGNMENT です。
#if defined(_WIN64) || defined(_M_ALPHA)
#define MEMORY_ALLOCATION_ALIGNMENT 16
#else
#define MEMORY_ALLOCATION_ALIGNMENT 8
#endif
さまざまな割り当てサイズで大量のメモリを割り当てるアプリケーションでは、低断片化ヒープ (low-fragmentation heap) を使用してヒープの断片化を軽減できます。
シリアル化は、2 つ以上のスレッドが同じヒープからブロックを同時に割り当てまたは解放しようとする際に、相互排他を保証します。シリアル化にはわずかなパフォーマンスコストがかかりますが、複数のスレッドが同じヒープからメモリを割り当て・解放する場合には必ず使用しなければなりません。HEAP_NO_SERIALIZE 値を設定すると、ヒープ上の相互排他が無効になります。シリアル化を行わない場合、同じヒープハンドルを使用する 2 つ以上のスレッドがメモリを同時に割り当てまたは解放しようとし、ヒープの破損を引き起こす可能性が高くなります。したがって、HEAP_NO_SERIALIZE 値を安全に使用できるのは、次の状況に限られます。
- プロセスにスレッドが 1 つしかない。
- プロセスに複数のスレッドがあるが、特定のヒープに対してヒープ関数を呼び出すスレッドが 1 つだけである。
- プロセスに複数のスレッドがあり、アプリケーションが特定のヒープに対する相互排他の独自のメカニズムを提供している。
例
例については、AWE Example を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
void* HeapAlloc(
HANDLE hHeap,
HEAP_FLAGS dwFlags,
UINT_PTR dwBytes
);[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern IntPtr HeapAlloc(
IntPtr hHeap, // HANDLE
uint dwFlags, // HEAP_FLAGS
UIntPtr dwBytes // UINT_PTR
);<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function HeapAlloc(
hHeap As IntPtr, ' HANDLE
dwFlags As UInteger, ' HEAP_FLAGS
dwBytes As UIntPtr ' UINT_PTR
) As IntPtr
End Function' hHeap : HANDLE
' dwFlags : HEAP_FLAGS
' dwBytes : UINT_PTR
Declare PtrSafe Function HeapAlloc Lib "kernel32" ( _
ByVal hHeap As LongPtr, _
ByVal dwFlags As Long, _
ByVal dwBytes As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
HeapAlloc = ctypes.windll.kernel32.HeapAlloc
HeapAlloc.restype = ctypes.c_void_p
HeapAlloc.argtypes = [
wintypes.HANDLE, # hHeap : HANDLE
wintypes.DWORD, # dwFlags : HEAP_FLAGS
ctypes.c_size_t, # dwBytes : UINT_PTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
HeapAlloc = Fiddle::Function.new(
lib['HeapAlloc'],
[
Fiddle::TYPE_VOIDP, # hHeap : HANDLE
-Fiddle::TYPE_INT, # dwFlags : HEAP_FLAGS
Fiddle::TYPE_UINTPTR_T, # dwBytes : UINT_PTR
],
Fiddle::TYPE_VOIDP)#[link(name = "kernel32")]
extern "system" {
fn HeapAlloc(
hHeap: *mut core::ffi::c_void, // HANDLE
dwFlags: u32, // HEAP_FLAGS
dwBytes: usize // UINT_PTR
) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll")]
public static extern IntPtr HeapAlloc(IntPtr hHeap, uint dwFlags, UIntPtr dwBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_HeapAlloc' -Namespace Win32 -PassThru
# $api::HeapAlloc(hHeap, dwFlags, dwBytes)#uselib "KERNEL32.dll"
#func global HeapAlloc "HeapAlloc" sptr, sptr, sptr
; HeapAlloc hHeap, dwFlags, dwBytes ; 戻り値は stat
; hHeap : HANDLE -> "sptr"
; dwFlags : HEAP_FLAGS -> "sptr"
; dwBytes : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global HeapAlloc "HeapAlloc" sptr, int, sptr
; res = HeapAlloc(hHeap, dwFlags, dwBytes)
; hHeap : HANDLE -> "sptr"
; dwFlags : HEAP_FLAGS -> "int"
; dwBytes : UINT_PTR -> "sptr"; void* HeapAlloc(HANDLE hHeap, HEAP_FLAGS dwFlags, UINT_PTR dwBytes)
#uselib "KERNEL32.dll"
#cfunc global HeapAlloc "HeapAlloc" intptr, int, intptr
; res = HeapAlloc(hHeap, dwFlags, dwBytes)
; hHeap : HANDLE -> "intptr"
; dwFlags : HEAP_FLAGS -> "int"
; dwBytes : UINT_PTR -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procHeapAlloc = kernel32.NewProc("HeapAlloc")
)
// hHeap (HANDLE), dwFlags (HEAP_FLAGS), dwBytes (UINT_PTR)
r1, _, err := procHeapAlloc.Call(
uintptr(hHeap),
uintptr(dwFlags),
uintptr(dwBytes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // void*function HeapAlloc(
hHeap: THandle; // HANDLE
dwFlags: DWORD; // HEAP_FLAGS
dwBytes: NativeUInt // UINT_PTR
): Pointer; stdcall;
external 'KERNEL32.dll' name 'HeapAlloc';result := DllCall("KERNEL32\HeapAlloc"
, "Ptr", hHeap ; HANDLE
, "UInt", dwFlags ; HEAP_FLAGS
, "UPtr", dwBytes ; UINT_PTR
, "Ptr") ; return: void*●HeapAlloc(hHeap, dwFlags, dwBytes) = DLL("KERNEL32.dll", "void* HeapAlloc(void*, dword, int)")
# 呼び出し: HeapAlloc(hHeap, dwFlags, dwBytes)
# hHeap : HANDLE -> "void*"
# dwFlags : HEAP_FLAGS -> "dword"
# dwBytes : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn HeapAlloc(
hHeap: ?*anyopaque, // HANDLE
dwFlags: u32, // HEAP_FLAGS
dwBytes: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc HeapAlloc(
hHeap: pointer, # HANDLE
dwFlags: uint32, # HEAP_FLAGS
dwBytes: uint # UINT_PTR
): pointer {.importc: "HeapAlloc", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void* HeapAlloc(
void* hHeap, // HANDLE
uint dwFlags, // HEAP_FLAGS
size_t dwBytes // UINT_PTR
);ccall((:HeapAlloc, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Ptr{Cvoid}, UInt32, Csize_t),
hHeap, dwFlags, dwBytes)
# hHeap : HANDLE -> Ptr{Cvoid}
# dwFlags : HEAP_FLAGS -> UInt32
# dwBytes : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* HeapAlloc(
void* hHeap,
uint32_t dwFlags,
uintptr_t dwBytes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.HeapAlloc(hHeap, dwFlags, dwBytes)
-- hHeap : HANDLE
-- dwFlags : HEAP_FLAGS
-- dwBytes : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const HeapAlloc = lib.func('__stdcall', 'HeapAlloc', 'void *', ['void *', 'uint32_t', 'uintptr_t']);
// HeapAlloc(hHeap, dwFlags, dwBytes)
// hHeap : HANDLE -> 'void *'
// dwFlags : HEAP_FLAGS -> 'uint32_t'
// dwBytes : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
HeapAlloc: { parameters: ["pointer", "u32", "usize"], result: "pointer" },
});
// lib.symbols.HeapAlloc(hHeap, dwFlags, dwBytes)
// hHeap : HANDLE -> "pointer"
// dwFlags : HEAP_FLAGS -> "u32"
// dwBytes : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* HeapAlloc(
void* hHeap,
uint32_t dwFlags,
size_t dwBytes);
C, "KERNEL32.dll");
// $ffi->HeapAlloc(hHeap, dwFlags, dwBytes);
// hHeap : HANDLE
// dwFlags : HEAP_FLAGS
// dwBytes : 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 HeapAlloc(
Pointer hHeap, // HANDLE
int dwFlags, // HEAP_FLAGS
long dwBytes // UINT_PTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun HeapAlloc = HeapAlloc(
hHeap : Void*, # HANDLE
dwFlags : UInt32, # HEAP_FLAGS
dwBytes : 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 HeapAllocNative = Pointer<Void> Function(Pointer<Void>, Uint32, UintPtr);
typedef HeapAllocDart = Pointer<Void> Function(Pointer<Void>, int, int);
final HeapAlloc = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<HeapAllocNative, HeapAllocDart>('HeapAlloc');
// hHeap : HANDLE -> Pointer<Void>
// dwFlags : HEAP_FLAGS -> Uint32
// dwBytes : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function HeapAlloc(
hHeap: THandle; // HANDLE
dwFlags: DWORD; // HEAP_FLAGS
dwBytes: NativeUInt // UINT_PTR
): Pointer; stdcall;
external 'KERNEL32.dll' name 'HeapAlloc';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "HeapAlloc"
c_HeapAlloc :: Ptr () -> Word32 -> CUIntPtr -> IO (Ptr ())
-- hHeap : HANDLE -> Ptr ()
-- dwFlags : HEAP_FLAGS -> Word32
-- dwBytes : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let heapalloc =
foreign "HeapAlloc"
((ptr void) @-> uint32_t @-> size_t @-> returning (ptr void))
(* hHeap : HANDLE -> (ptr void) *)
(* dwFlags : HEAP_FLAGS -> uint32_t *)
(* dwBytes : 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 ("HeapAlloc" heap-alloc :convention :stdcall) :pointer
(h-heap :pointer) ; HANDLE
(dw-flags :uint32) ; HEAP_FLAGS
(dw-bytes :uint64)) ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $HeapAlloc = Win32::API::More->new('KERNEL32',
'LPVOID HeapAlloc(HANDLE hHeap, DWORD dwFlags, WPARAM dwBytes)');
# my $ret = $HeapAlloc->Call($hHeap, $dwFlags, $dwBytes);
# hHeap : HANDLE -> HANDLE
# dwFlags : HEAP_FLAGS -> DWORD
# dwBytes : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。