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

ReclaimVirtualMemory

関数
OfferVirtualMemoryで提供したメモリ範囲を再要求する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

DWORD ReclaimVirtualMemory(
    const void* VirtualAddress,
    UINT_PTR Size
);

パラメーター

名前方向説明
VirtualAddressvoid*in再要求するメモリの、ページ境界に整列された開始アドレス。
SizeUINT_PTRin再要求するメモリ領域のサイズ(バイト単位)。Size はシステムのページサイズの整数倍である必要があります。

戻り値の型: DWORD

公式ドキュメント

OfferVirtualMemory によってシステムに譲渡したメモリページの範囲を再要求します。

戻り値

成功し、メモリがそのまま再要求された場合は ERROR_SUCCESS を返します。

成功したものの、メモリが破棄されておりアプリケーションによる再書き込みが必要な場合は ERROR_BUSY を返します。この場合、メモリ領域の内容は未定義です。

それ以外の場合はシステムエラーコードを返します。

解説(Remarks)

再要求されたメモリページはアプリケーションが使用でき、ページングが発生した場合はシステムのページファイルに書き込まれます。

この関数が ERROR_SUCCESS を返した場合、再要求されたページ内のデータは有効です。 この関数が ERROR_BUSY を返した場合、再要求されたページ内のデータはシステムによって破棄されており、もはや有効ではありません。 このため、メモリをシステムに譲渡するのは、アプリケーションがそのデータを必要としないか、または再生成できる場合に限るべきです。

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

各言語での呼び出し定義

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

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

ReclaimVirtualMemory = ctypes.windll.kernel32.ReclaimVirtualMemory
ReclaimVirtualMemory.restype = wintypes.DWORD
ReclaimVirtualMemory.argtypes = [
    ctypes.POINTER(None),  # VirtualAddress : void*
    ctypes.c_size_t,  # Size : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReclaimVirtualMemory = kernel32.NewProc("ReclaimVirtualMemory")
)

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

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

typedef ReclaimVirtualMemoryNative = Uint32 Function(Pointer<Void>, UintPtr);
typedef ReclaimVirtualMemoryDart = int Function(Pointer<Void>, int);
final ReclaimVirtualMemory = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ReclaimVirtualMemoryNative, ReclaimVirtualMemoryDart>('ReclaimVirtualMemory');
// VirtualAddress : void* -> Pointer<Void>
// Size : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReclaimVirtualMemory(
  VirtualAddress: Pointer;   // void*
  Size: NativeUInt   // UINT_PTR
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'ReclaimVirtualMemory';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReclaimVirtualMemory"
  c_ReclaimVirtualMemory :: Ptr () -> CUIntPtr -> IO Word32
-- VirtualAddress : void* -> Ptr ()
-- Size : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let reclaimvirtualmemory =
  foreign "ReclaimVirtualMemory"
    ((ptr void) @-> size_t @-> returning uint32_t)
(* VirtualAddress : void* -> (ptr void) *)
(* Size : 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 ("ReclaimVirtualMemory" reclaim-virtual-memory :convention :stdcall) :uint32
  (virtual-address :pointer)   ; void*
  (size :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReclaimVirtualMemory = Win32::API::More->new('KERNEL32',
    'DWORD ReclaimVirtualMemory(LPVOID VirtualAddress, WPARAM Size)');
# my $ret = $ReclaimVirtualMemory->Call($VirtualAddress, $Size);
# VirtualAddress : void* -> LPVOID
# Size : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目