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

VirtualUnlock

関数
VirtualLockでロックした範囲のメモリのロックを解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL VirtualUnlock(
    void* lpAddress,
    UINT_PTR dwSize
);

パラメーター

名前方向説明
lpAddressvoid*inロックを解除するページ領域の基底アドレスへのポインター。
dwSizeUINT_PTRinロックを解除する領域のサイズ(バイト単位)。影響を受けるページ領域には、lpAddress パラメーターから (lpAddress+dwSize) までの範囲に 1 バイト以上を含むすべてのページが含まれます。つまり、ページ境界をまたぐ 2 バイトの範囲では、両方のページのロックが解除されます。

戻り値の型: BOOL

公式ドキュメント

プロセスの仮想アドレス空間における指定範囲のページのロックを解除し、必要に応じてシステムがそれらのページをページングファイルにスワップアウトできるようにします。

戻り値

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

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

解説(Remarks)

この関数が成功するために、指定する範囲が、以前に VirtualLock 関数の呼び出しに渡した範囲と一致する必要はありませんが、範囲内のすべてのページがロックされている必要があります。指定範囲内のいずれかのページがロックされていない場合、VirtualUnlock はそれらのページをワーキングセットから削除し、最終エラーを ERROR_NOT_LOCKED に設定して、FALSE を返します。

ロックされていないメモリ範囲に対して VirtualUnlock を呼び出すと、それらのページはプロセスのワーキングセットから解放されます。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
VirtualUnlock = Fiddle::Function.new(
  lib['VirtualUnlock'],
  [
    Fiddle::TYPE_VOIDP,  # lpAddress : void*
    Fiddle::TYPE_UINTPTR_T,  # dwSize : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn VirtualUnlock(
        lpAddress: *mut (),  // void*
        dwSize: 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 VirtualUnlock(IntPtr lpAddress, UIntPtr dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_VirtualUnlock' -Namespace Win32 -PassThru
# $api::VirtualUnlock(lpAddress, dwSize)
#uselib "KERNEL32.dll"
#func global VirtualUnlock "VirtualUnlock" sptr, sptr
; VirtualUnlock lpAddress, dwSize   ; 戻り値は stat
; lpAddress : void* -> "sptr"
; dwSize : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global VirtualUnlock "VirtualUnlock" sptr, sptr
; res = VirtualUnlock(lpAddress, dwSize)
; lpAddress : void* -> "sptr"
; dwSize : UINT_PTR -> "sptr"
; BOOL VirtualUnlock(void* lpAddress, UINT_PTR dwSize)
#uselib "KERNEL32.dll"
#cfunc global VirtualUnlock "VirtualUnlock" intptr, intptr
; res = VirtualUnlock(lpAddress, dwSize)
; lpAddress : void* -> "intptr"
; dwSize : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procVirtualUnlock = kernel32.NewProc("VirtualUnlock")
)

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

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

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

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

関連項目

類似 API
公式の関連項目