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

OfferVirtualMemory

関数
指定仮想メモリ範囲を不要としてシステムへ提供する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

DWORD OfferVirtualMemory(
    void* VirtualAddress,
    UINT_PTR Size,
    OFFER_PRIORITY Priority
);

パラメーター

名前方向説明
VirtualAddressvoid*inoutオファーするメモリの、ページ境界に整列した開始アドレス。
SizeUINT_PTRinオファーするメモリ領域のサイズ(バイト単位)。Size はシステムのページサイズの整数倍でなければなりません。
PriorityOFFER_PRIORITYin

Priority は、オファーするメモリがアプリケーションにとってどれほど重要かを示します。 優先度が高いほど、ReclaimVirtualMemory を呼び出した際に、オファーしたメモリを内容を保ったまま回収できる可能性が高くなります。 システムは通常、優先度の高いメモリを破棄する前に、優先度の低いメモリを破棄します。 Priority は次のいずれかの値でなければなりません。

意味
VMOfferPriorityVeryLow
0x00000001
オファーするメモリは非常に低い優先度であり、最初に破棄されるべきものです。
VMOfferPriorityLow
0x00000002
オファーするメモリは低い優先度です。
VMOfferPriorityBelowNormal
0x00000003
オファーするメモリは標準より低い優先度です。
VMOfferPriorityNormal
0x00000004
オファーするメモリはアプリケーションにとって標準の優先度であり、最後に破棄されるべきものです。

戻り値の型: DWORD

公式ドキュメント

指定したメモリページ範囲に含まれるデータがアプリケーションにとって不要になり、必要に応じてシステムが破棄してもよいことを示します。

戻り値

成功した場合は ERROR_SUCCESS。失敗した場合はシステムエラーコードを返します。

解説(Remarks)

オファーしたページを回収するには、ReclaimVirtualMemory を呼び出します。 回収されたページのデータは破棄されている場合があり、その場合メモリ領域の内容は未定義となるため、アプリケーションが書き直す必要があります。

ロックされている仮想メモリをオファーするために OfferVirtualMemory を呼び出さないでください。 呼び出すと、指定したページ範囲のロックが解除されます。

仮想メモリのオファーと回収は、MEM_RESET および MEM_RESET_UNDO メモリ割り当てフラグを使用する場合と似ていますが、OfferVirtualMemory はメモリをプロセスのワーキングセットから取り除き、オファーしたページが回収されるまでそのアクセスを制限する点が異なります。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOfferVirtualMemory = kernel32.NewProc("OfferVirtualMemory")
)

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

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

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

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

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

(cffi:defcfun ("OfferVirtualMemory" offer-virtual-memory :convention :stdcall) :uint32
  (virtual-address :pointer)   ; void* in/out
  (size :uint64)   ; UINT_PTR
  (priority :int32))   ; OFFER_PRIORITY
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OfferVirtualMemory = Win32::API::More->new('KERNEL32',
    'DWORD OfferVirtualMemory(LPVOID VirtualAddress, WPARAM Size, int Priority)');
# my $ret = $OfferVirtualMemory->Call($VirtualAddress, $Size, $Priority);
# VirtualAddress : void* in/out -> LPVOID
# Size : UINT_PTR -> WPARAM
# Priority : OFFER_PRIORITY -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型