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

VirtualFree

関数
確保した仮想メモリ領域を解放または解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL VirtualFree(
    void* lpAddress,
    UINT_PTR dwSize,
    VIRTUAL_FREE_TYPE dwFreeType
);

パラメーター

名前方向説明
lpAddressvoid*inout

解放するページ領域のベースアドレスへのポインターです。

dwFreeType パラメーターが MEM_RELEASE の場合、このパラメーターには、ページ領域を予約したときに VirtualAlloc 関数が返したベースアドレスを指定する必要があります。

dwSizeUINT_PTRin

解放するメモリ領域のサイズ(バイト単位)です。

dwFreeType パラメーターが MEM_RELEASE の場合、このパラメーターは 0 でなければなりません。この関数は、最初の割り当て呼び出しで VirtualAlloc によって予約された領域全体を解放します。

dwFreeType パラメーターが MEM_DECOMMIT の場合、この関数は、lpAddress パラメーターから (lpAddress+dwSize) までの範囲に 1 バイト以上を含むすべてのメモリページのコミットを解除します。たとえば、ページ境界をまたぐ 2 バイトのメモリ領域は、両方のページのコミットを解除させることになります。lpAddressVirtualAlloc が返したベースアドレスであり、dwSize が 0 の場合、この関数は VirtualAlloc によって割り当てられた領域全体のコミットを解除します。その後、領域全体は予約状態になります。

dwFreeTypeVIRTUAL_FREE_TYPEin

解放操作の種類です。このパラメーターには、次のいずれかの値を指定する必要があります。

意味
MEM_DECOMMIT
0x00004000
指定されたコミット済みページ領域のコミットを解除します。操作後、ページは予約状態になります。

コミットされていないページのコミットを解除しようとしても、この関数は失敗しません。つまり、現在のコミット状態を事前に確認することなく、ページ範囲のコミットを解除できます。

MEM_DECOMMIT 値は、lpAddress パラメーターがエンクレーブのベースアドレスを指定している場合はサポートされません。これは、動的メモリ管理をサポートしないエンクレーブ(すなわち SGX1)に当てはまります。SGX2 エンクレーブでは、エンクレーブ内の任意の場所で MEM_DECOMMIT が許可されます。

MEM_RELEASE
0x00008000
指定されたページ領域またはプレースホルダーを解放します(プレースホルダーの場合、アドレス空間が解放され、他の割り当てに利用できるようになります)。この操作後、ページは空き状態になります。

この値を指定する場合、dwSize は 0 でなければならず、lpAddress は領域を予約したときに VirtualAlloc 関数が返したベースアドレスを指している必要があります。これらの条件のいずれかが満たされない場合、この関数は失敗します。

領域内に現在コミットされているページがある場合、この関数はまずそれらのコミットを解除してから解放します。

一部が予約済み、一部がコミット済みといった異なる状態のページを解放しようとしても、この関数は失敗しません。つまり、現在のコミット状態を事前に確認することなく、ページ範囲を解放できます。

MEM_RELEASE を使用する場合、このパラメーターには次のいずれかの値を追加で指定できます。

意味
MEM_COALESCE_PLACEHOLDERS
0x00000001
隣接する 2 つのプレースホルダーを結合するには、MEM_RELEASE | MEM_COALESCE_PLACEHOLDERS を指定します。プレースホルダーを結合する場合、lpAddressdwSize は、結合対象のプレースホルダー全体の範囲と正確に一致する必要があります。
MEM_PRESERVE_PLACEHOLDER
0x00000002
割り当てをプレースホルダーに戻します(VirtualAlloc2 または Virtual2AllocFromApp を使用してプレースホルダーをプライベート割り当てに置き換えた後に使用します)。

プレースホルダーを 2 つのプレースホルダーに分割するには、MEM_RELEASE | MEM_PRESERVE_PLACEHOLDER を指定します。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスの仮想アドレス空間内のページ領域を、解放(release)、コミット解除(decommit)、またはその両方を行います。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

プロセスの仮想アドレス空間内の各メモリページには ページ状態 があります。VirtualFree 関数は、一部がコミット済み、一部が未コミットといった異なる状態のページ範囲のコミットを解除できます。つまり、各ページの現在のコミット状態を事前に確認することなく、ページ範囲のコミットを解除できます。ページのコミットを解除すると、メモリ内またはディスク上のページングファイル内のいずれかにある物理ストレージが解放されます。

ページがコミット解除されたものの解放されていない場合、その状態は予約済みに変わります。その後、VirtualAlloc を呼び出してコミットするか、VirtualFree を呼び出して解放できます。予約済みページへの読み取りまたは書き込みを試みると、アクセス違反例外が発生します。

VirtualFree 関数は、一部が予約済み、一部がコミット済みといった異なる状態のページ範囲を解放できます。つまり、各ページの現在のコミット状態を事前に確認することなく、ページ範囲を解放できます。VirtualAlloc 関数で最初に予約されたページ範囲全体を同時に解放する必要があります。

ページが解放されると、その状態は空きに変わり、後続の割り当て操作に利用できるようになります。メモリが解放またはコミット解除された後は、そのメモリを二度と参照することはできません。そのメモリに含まれていた可能性のある情報は永久に失われます。空きページへの読み取りまたは書き込みを試みると、アクセス違反例外が発生します。情報を保持する必要がある場合は、その情報を含むメモリのコミット解除または解放を行わないでください。

VirtualFree 関数は AWE 領域のメモリに対して使用でき、アドレス空間を解放する際に領域内の物理ページマッピングを無効化します。ただし、物理ページは削除されず、アプリケーションはそれらを使用できます。アプリケーションは、物理ページを解放するために FreeUserPhysicalPages を明示的に呼び出す必要があります。プロセスが終了すると、すべてのリソースが自動的にクリーンアップされます。

Windows 10 バージョン 1709 以降および Windows 11: エンクレーブの使用を終えた後にそれを削除するには、DeleteEnclave を呼び出します。VBS エンクレーブは VirtualFree または VirtualFreeEx 関数を呼び出して削除することはできません。SGX エンクレーブは引き続き VirtualFree または VirtualFreeEx を呼び出して削除できます。

Windows 10 バージョン 1507、Windows 10 バージョン 1511、Windows 10 バージョン 1607 および Windows 10 バージョン 1703: エンクレーブの使用を終えた後にそれを削除するには、VirtualFree または VirtualFreeEx 関数を呼び出し、次の値を指定します。

例については、メモリの予約とコミット を参照してください。

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

各言語での呼び出し定義

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

BOOL VirtualFree(
    void* lpAddress,
    UINT_PTR dwSize,
    VIRTUAL_FREE_TYPE dwFreeType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool VirtualFree(
    IntPtr lpAddress,   // void* in/out
    UIntPtr dwSize,   // UINT_PTR
    uint dwFreeType   // VIRTUAL_FREE_TYPE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function VirtualFree(
    lpAddress As IntPtr,   ' void* in/out
    dwSize As UIntPtr,   ' UINT_PTR
    dwFreeType As UInteger   ' VIRTUAL_FREE_TYPE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpAddress : void* in/out
' dwSize : UINT_PTR
' dwFreeType : VIRTUAL_FREE_TYPE
Declare PtrSafe Function VirtualFree Lib "kernel32" ( _
    ByVal lpAddress As LongPtr, _
    ByVal dwSize As LongPtr, _
    ByVal dwFreeType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VirtualFree = ctypes.windll.kernel32.VirtualFree
VirtualFree.restype = wintypes.BOOL
VirtualFree.argtypes = [
    ctypes.POINTER(None),  # lpAddress : void* in/out
    ctypes.c_size_t,  # dwSize : UINT_PTR
    wintypes.DWORD,  # dwFreeType : VIRTUAL_FREE_TYPE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procVirtualFree = kernel32.NewProc("VirtualFree")
)

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

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

typedef VirtualFreeNative = Int32 Function(Pointer<Void>, UintPtr, Uint32);
typedef VirtualFreeDart = int Function(Pointer<Void>, int, int);
final VirtualFree = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<VirtualFreeNative, VirtualFreeDart>('VirtualFree');
// lpAddress : void* in/out -> Pointer<Void>
// dwSize : UINT_PTR -> UintPtr
// dwFreeType : VIRTUAL_FREE_TYPE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VirtualFree(
  lpAddress: Pointer;   // void* in/out
  dwSize: NativeUInt;   // UINT_PTR
  dwFreeType: DWORD   // VIRTUAL_FREE_TYPE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'VirtualFree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VirtualFree"
  c_VirtualFree :: Ptr () -> CUIntPtr -> Word32 -> IO CInt
-- lpAddress : void* in/out -> Ptr ()
-- dwSize : UINT_PTR -> CUIntPtr
-- dwFreeType : VIRTUAL_FREE_TYPE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let virtualfree =
  foreign "VirtualFree"
    ((ptr void) @-> size_t @-> uint32_t @-> returning int32_t)
(* lpAddress : void* in/out -> (ptr void) *)
(* dwSize : UINT_PTR -> size_t *)
(* dwFreeType : VIRTUAL_FREE_TYPE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("VirtualFree" virtual-free :convention :stdcall) :int32
  (lp-address :pointer)   ; void* in/out
  (dw-size :uint64)   ; UINT_PTR
  (dw-free-type :uint32))   ; VIRTUAL_FREE_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VirtualFree = Win32::API::More->new('KERNEL32',
    'BOOL VirtualFree(LPVOID lpAddress, WPARAM dwSize, DWORD dwFreeType)');
# my $ret = $VirtualFree->Call($lpAddress, $dwSize, $dwFreeType);
# lpAddress : void* in/out -> LPVOID
# dwSize : UINT_PTR -> WPARAM
# dwFreeType : VIRTUAL_FREE_TYPE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型