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

HeapReAlloc

関数
ヒープ上のメモリブロックを再割り当てする。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

void* HeapReAlloc(
    HANDLE hHeap,
    HEAP_FLAGS dwFlags,
    void* lpMem,   // optional
    UINT_PTR dwBytes
);

パラメーター

名前方向説明
hHeapHANDLEinoutメモリの再割り当て元となるヒープへのハンドル。このハンドルは、HeapCreate 関数または GetProcessHeap 関数によって返されます。
dwFlagsHEAP_FLAGSin

ヒープの再割り当てオプション。値を指定すると、HeapCreate 関数でヒープを作成した際に flOptions パラメーターで指定した対応する値を上書きします。このパラメーターには、次の値の 1 つ以上を指定できます。

意味
HEAP_GENERATE_EXCEPTIONS
0x00000004
メモリ不足などの関数の失敗を示すために、オペレーティングシステムは NULL を返す代わりに例外を発生させます。

この関数のすべての呼び出しで例外が確実に生成されるようにするには、HeapCreate の呼び出しで HEAP_GENERATE_EXCEPTIONS を指定します。この場合、この関数の呼び出しで HEAP_GENERATE_EXCEPTIONS を追加で指定する必要はありません。

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

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

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

HEAP_REALLOC_IN_PLACE_ONLY
0x00000010
メモリブロックを再割り当てする際に移動が発生しないようにします。この値を指定しない場合、関数はブロックを新しい場所に移動することがあります。この値を指定し、かつ移動せずにブロックのサイズを変更できない場合、関数は失敗し、元のメモリブロックは変更されないまま残ります。
HEAP_ZERO_MEMORY
0x00000008
再割り当て要求がより大きいサイズを要求する場合、元のサイズを超えて追加されたメモリ領域はゼロに初期化されます。元のサイズまでのメモリブロックの内容は影響を受けません。
lpMemvoid*inoptional関数が再割り当てするメモリブロックへのポインター。このポインターは、以前の HeapAlloc 関数または HeapReAlloc 関数の呼び出しによって返されたものです。
dwBytesUINT_PTRin

メモリブロックの新しいサイズ(バイト単位)。この関数を使用して、メモリブロックのサイズを増減できます。

hHeap パラメーターで指定されたヒープが「拡張不可能な」ヒープである場合、dwBytes は 0x7FFF8 未満でなければなりません。拡張不可能なヒープは、HeapCreate 関数を非ゼロの値で呼び出すことによって作成します。

戻り値の型: void*

公式ドキュメント

ヒープからメモリブロックを再割り当てします。この関数を使用すると、メモリブロックのサイズを変更したり、その他のメモリブロックのプロパティを変更したりできます。

戻り値

関数が成功した場合、戻り値は再割り当てされたメモリブロックへのポインターです。

関数が失敗し、かつ HEAP_GENERATE_EXCEPTIONS を指定していない場合、戻り値は NULL です。

関数が失敗し、かつ HEAP_GENERATE_EXCEPTIONS を指定している場合、関数は次の表に示す例外のいずれかを生成することがあります。詳細については、GetExceptionCode を参照してください。

例外コード 説明
STATUS_NO_MEMORY 利用可能なメモリの不足またはヒープの破損のため、割り当ての試行が失敗しました。
STATUS_ACCESS_VIOLATION ヒープの破損または不適切な関数パラメーターのため、割り当ての試行が失敗しました。

HeapReAlloc が返すメモリのアラインメントは、WinNT.h の MEMORY_ALLOCATION_ALIGNMENT です。

#if defined(_WIN64) || defined(_M_ALPHA)
#define MEMORY_ALLOCATION_ALIGNMENT 16
#else
#define MEMORY_ALLOCATION_ALIGNMENT 8
#endif

関数が失敗した場合、SetLastError は呼び出されません。アプリケーションは拡張エラー情報を得るために GetLastError を呼び出すことはできません。

解説(Remarks)

HeapReAlloc が成功した場合、少なくとも要求された量のメモリを割り当てます。

HeapReAlloc が失敗した場合、元のメモリは解放されず、元のハンドルとポインターは引き続き有効です。

HeapReAlloc は、新しいメモリが別の場所に割り当てられた場合でも、再割り当て中のメモリの内容を保持することが保証されています。メモリ内容を保持する処理には、非常に時間がかかる可能性のあるメモリコピー操作が伴います。

HeapReAlloc によって割り当てられたメモリブロックを解放するには、HeapFree 関数を使用します。

シリアル化は、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>

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

HeapReAlloc = ctypes.windll.kernel32.HeapReAlloc
HeapReAlloc.restype = ctypes.c_void_p
HeapReAlloc.argtypes = [
    wintypes.HANDLE,  # hHeap : HANDLE in/out
    wintypes.DWORD,  # dwFlags : HEAP_FLAGS
    ctypes.POINTER(None),  # lpMem : void* optional
    ctypes.c_size_t,  # dwBytes : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procHeapReAlloc = kernel32.NewProc("HeapReAlloc")
)

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

extern "kernel32" fn HeapReAlloc(
    hHeap: ?*anyopaque, // HANDLE in/out
    dwFlags: u32, // HEAP_FLAGS
    lpMem: ?*anyopaque, // void* optional
    dwBytes: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc HeapReAlloc(
    hHeap: pointer,  # HANDLE in/out
    dwFlags: uint32,  # HEAP_FLAGS
    lpMem: pointer,  # void* optional
    dwBytes: uint  # UINT_PTR
): pointer {.importc: "HeapReAlloc", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* HeapReAlloc(
    void* hHeap,   // HANDLE in/out
    uint dwFlags,   // HEAP_FLAGS
    void* lpMem,   // void* optional
    size_t dwBytes   // UINT_PTR
);
ccall((:HeapReAlloc, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Csize_t),
      hHeap, dwFlags, lpMem, dwBytes)
# hHeap : HANDLE in/out -> Ptr{Cvoid}
# dwFlags : HEAP_FLAGS -> UInt32
# lpMem : void* optional -> Ptr{Cvoid}
# dwBytes : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* HeapReAlloc(
    void* hHeap,
    uint32_t dwFlags,
    void* lpMem,
    uintptr_t dwBytes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.HeapReAlloc(hHeap, dwFlags, lpMem, dwBytes)
-- hHeap : HANDLE in/out
-- dwFlags : HEAP_FLAGS
-- lpMem : void* optional
-- dwBytes : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const HeapReAlloc = lib.func('__stdcall', 'HeapReAlloc', 'void *', ['void *', 'uint32_t', 'void *', 'uintptr_t']);
// HeapReAlloc(hHeap, dwFlags, lpMem, dwBytes)
// hHeap : HANDLE in/out -> 'void *'
// dwFlags : HEAP_FLAGS -> 'uint32_t'
// lpMem : void* optional -> 'void *'
// dwBytes : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  HeapReAlloc: { parameters: ["pointer", "u32", "pointer", "usize"], result: "pointer" },
});
// lib.symbols.HeapReAlloc(hHeap, dwFlags, lpMem, dwBytes)
// hHeap : HANDLE in/out -> "pointer"
// dwFlags : HEAP_FLAGS -> "u32"
// lpMem : void* optional -> "pointer"
// dwBytes : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* HeapReAlloc(
    void* hHeap,
    uint32_t dwFlags,
    void* lpMem,
    size_t dwBytes);
C, "KERNEL32.dll");
// $ffi->HeapReAlloc(hHeap, dwFlags, lpMem, dwBytes);
// hHeap : HANDLE in/out
// dwFlags : HEAP_FLAGS
// lpMem : void* optional
// 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 HeapReAlloc(
        Pointer hHeap,   // HANDLE in/out
        int dwFlags,   // HEAP_FLAGS
        Pointer lpMem,   // void* optional
        long dwBytes   // UINT_PTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun HeapReAlloc = HeapReAlloc(
    hHeap : Void*,   # HANDLE in/out
    dwFlags : UInt32,   # HEAP_FLAGS
    lpMem : Void*,   # void* optional
    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 HeapReAllocNative = Pointer<Void> Function(Pointer<Void>, Uint32, Pointer<Void>, UintPtr);
typedef HeapReAllocDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Void>, int);
final HeapReAlloc = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<HeapReAllocNative, HeapReAllocDart>('HeapReAlloc');
// hHeap : HANDLE in/out -> Pointer<Void>
// dwFlags : HEAP_FLAGS -> Uint32
// lpMem : void* optional -> Pointer<Void>
// dwBytes : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HeapReAlloc(
  hHeap: THandle;   // HANDLE in/out
  dwFlags: DWORD;   // HEAP_FLAGS
  lpMem: Pointer;   // void* optional
  dwBytes: NativeUInt   // UINT_PTR
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'HeapReAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let heaprealloc =
  foreign "HeapReAlloc"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> size_t @-> returning (ptr void))
(* hHeap : HANDLE in/out -> (ptr void) *)
(* dwFlags : HEAP_FLAGS -> uint32_t *)
(* lpMem : void* optional -> (ptr void) *)
(* 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 ("HeapReAlloc" heap-re-alloc :convention :stdcall) :pointer
  (h-heap :pointer)   ; HANDLE in/out
  (dw-flags :uint32)   ; HEAP_FLAGS
  (lp-mem :pointer)   ; void* optional
  (dw-bytes :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HeapReAlloc = Win32::API::More->new('KERNEL32',
    'LPVOID HeapReAlloc(HANDLE hHeap, DWORD dwFlags, LPVOID lpMem, WPARAM dwBytes)');
# my $ret = $HeapReAlloc->Call($hHeap, $dwFlags, $lpMem, $dwBytes);
# hHeap : HANDLE in/out -> HANDLE
# dwFlags : HEAP_FLAGS -> DWORD
# lpMem : void* optional -> LPVOID
# dwBytes : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型