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

FreeUserPhysicalPages

関数
AWEで割り当てた物理メモリページを解放する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL FreeUserPhysicalPages(
    HANDLE hProcess,
    UINT_PTR* NumberOfPages,
    UINT_PTR* PageArray
);

パラメーター

名前方向説明
hProcessHANDLEin

プロセスのハンドル。

この関数は、このプロセスの仮想アドレス空間内のメモリを解放します。

NumberOfPagesUINT_PTR*inout

解放する物理メモリのサイズ(ページ単位)。

関数が失敗した場合、戻り時にこのパラメーターは解放されたページ数を示します。

PageArrayUINT_PTR*in解放する割り当て済みメモリのページ フレーム番号の配列へのポインター。

戻り値の型: BOOL

公式ドキュメント

以前に AllocateUserPhysicalPages または AllocateUserPhysicalPagesNuma を使用して割り当てた物理メモリ ページを解放します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。この場合、NumberOfPages パラメーターは実際に解放されたページ数を反映します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

マルチプロセッサ環境では、この関数はハードウェア変換バッファーのコヒーレンシーを維持します。この関数が戻ると、すべてのプロセッサ上のすべてのスレッドが正しいマッピングを参照することが保証されます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0500 以降として定義します。詳細については、Windows ヘッダーの使用を参照してください。

例については、AWE の例を参照してください。

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

各言語での呼び出し定義

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

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

FreeUserPhysicalPages = ctypes.windll.kernel32.FreeUserPhysicalPages
FreeUserPhysicalPages.restype = wintypes.BOOL
FreeUserPhysicalPages.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(ctypes.c_size_t),  # NumberOfPages : UINT_PTR* in/out
    ctypes.POINTER(ctypes.c_size_t),  # PageArray : UINT_PTR*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FreeUserPhysicalPages = Fiddle::Function.new(
  lib['FreeUserPhysicalPages'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # NumberOfPages : UINT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # PageArray : UINT_PTR*
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn FreeUserPhysicalPages(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        NumberOfPages: *mut usize,  // UINT_PTR* in/out
        PageArray: *mut usize  // UINT_PTR*
    ) -> 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 FreeUserPhysicalPages(IntPtr hProcess, ref UIntPtr NumberOfPages, ref UIntPtr PageArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FreeUserPhysicalPages' -Namespace Win32 -PassThru
# $api::FreeUserPhysicalPages(hProcess, NumberOfPages, PageArray)
#uselib "KERNEL32.dll"
#func global FreeUserPhysicalPages "FreeUserPhysicalPages" sptr, sptr, sptr
; FreeUserPhysicalPages hProcess, varptr(NumberOfPages), varptr(PageArray)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; NumberOfPages : UINT_PTR* in/out -> "sptr"
; PageArray : UINT_PTR* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FreeUserPhysicalPages "FreeUserPhysicalPages" sptr, var, var
; res = FreeUserPhysicalPages(hProcess, NumberOfPages, PageArray)
; hProcess : HANDLE -> "sptr"
; NumberOfPages : UINT_PTR* in/out -> "var"
; PageArray : UINT_PTR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FreeUserPhysicalPages(HANDLE hProcess, UINT_PTR* NumberOfPages, UINT_PTR* PageArray)
#uselib "KERNEL32.dll"
#cfunc global FreeUserPhysicalPages "FreeUserPhysicalPages" intptr, var, var
; res = FreeUserPhysicalPages(hProcess, NumberOfPages, PageArray)
; hProcess : HANDLE -> "intptr"
; NumberOfPages : UINT_PTR* in/out -> "var"
; PageArray : UINT_PTR* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFreeUserPhysicalPages = kernel32.NewProc("FreeUserPhysicalPages")
)

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

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

typedef FreeUserPhysicalPagesNative = Int32 Function(Pointer<Void>, Pointer<UintPtr>, Pointer<UintPtr>);
typedef FreeUserPhysicalPagesDart = int Function(Pointer<Void>, Pointer<UintPtr>, Pointer<UintPtr>);
final FreeUserPhysicalPages = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FreeUserPhysicalPagesNative, FreeUserPhysicalPagesDart>('FreeUserPhysicalPages');
// hProcess : HANDLE -> Pointer<Void>
// NumberOfPages : UINT_PTR* in/out -> Pointer<UintPtr>
// PageArray : UINT_PTR* -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FreeUserPhysicalPages(
  hProcess: THandle;   // HANDLE
  NumberOfPages: Pointer;   // UINT_PTR* in/out
  PageArray: Pointer   // UINT_PTR*
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FreeUserPhysicalPages';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FreeUserPhysicalPages"
  c_FreeUserPhysicalPages :: Ptr () -> Ptr CUIntPtr -> Ptr CUIntPtr -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- NumberOfPages : UINT_PTR* in/out -> Ptr CUIntPtr
-- PageArray : UINT_PTR* -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let freeuserphysicalpages =
  foreign "FreeUserPhysicalPages"
    ((ptr void) @-> (ptr size_t) @-> (ptr size_t) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* NumberOfPages : UINT_PTR* in/out -> (ptr size_t) *)
(* PageArray : UINT_PTR* -> (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 ("FreeUserPhysicalPages" free-user-physical-pages :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (number-of-pages :pointer)   ; UINT_PTR* in/out
  (page-array :pointer))   ; UINT_PTR*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeUserPhysicalPages = Win32::API::More->new('KERNEL32',
    'BOOL FreeUserPhysicalPages(HANDLE hProcess, LPVOID NumberOfPages, LPVOID PageArray)');
# my $ret = $FreeUserPhysicalPages->Call($hProcess, $NumberOfPages, $PageArray);
# hProcess : HANDLE -> HANDLE
# NumberOfPages : UINT_PTR* in/out -> LPVOID
# PageArray : UINT_PTR* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目