VirtualQuery

関数

仮想アドレス空間のメモリ領域情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

UINT_PTR VirtualQuery(
    const void* lpAddress,   // optional
    MEMORY_BASIC_INFORMATION* lpBuffer,
    UINT_PTR dwLength
);

パラメーター

名前	型	方向	説明
lpAddress	void*	inoptional	クエリ対象となるページ領域のベースアドレスへのポインターです。この値は、直前のページ境界へ切り下げられます。ホストコンピューター上のページサイズを調べるには、GetSystemInfo 関数を使用してください。 lpAddress が、プロセスからアクセス可能な最上位のメモリアドレスを超えるアドレスを指定している場合、関数は失敗し、ERROR_INVALID_PARAMETER を返します。
lpBuffer	MEMORY_BASIC_INFORMATION*	out	指定したページ範囲に関する情報が返される MEMORY_BASIC_INFORMATION 構造体へのポインターです。
dwLength	UINT_PTR	in	lpBuffer パラメーターが指すバッファーのサイズ(バイト単位)です。

名前

型

方向

説明

lpAddress

void*

inoptional

クエリ対象となるページ領域のベースアドレスへのポインターです。この値は、直前のページ境界へ切り下げられます。ホストコンピューター上のページサイズを調べるには、GetSystemInfo 関数を使用してください。

lpAddress が、プロセスからアクセス可能な最上位のメモリアドレスを超えるアドレスを指定している場合、関数は失敗し、ERROR_INVALID_PARAMETER を返します。

lpBuffer

MEMORY_BASIC_INFORMATION*

out

指定したページ範囲に関する情報が返される MEMORY_BASIC_INFORMATION 構造体へのポインターです。

dwLength

UINT_PTR

lpBuffer パラメーターが指すバッファーのサイズ(バイト単位)です。

戻り値の型: UINT_PTR

公式ドキュメント

呼び出し元プロセスの仮想アドレス空間内にあるページ範囲に関する情報を取得します。

戻り値

戻り値は、情報バッファーに返された実際のバイト数です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。返される可能性のあるエラー値には ERROR_INVALID_PARAMETER が含まれます。

解説(Remarks)

VirtualQuery は、指定したアドレスから始まる連続したページ領域に関する情報を提供します。これらのページは次の属性を共有しています。

すべてのページの状態が同一であること(MEM_COMMIT、MEM_RESERVE、MEM_FREE、MEM_PRIVATE、MEM_MAPPED、または MEM_IMAGE)。
先頭ページが空き状態でない場合、領域内のすべてのページが、VirtualAlloc、MapViewOfFile、またはこれらの拡張版である次のいずれかの関数(VirtualAllocEx、VirtualAllocExNuma、MapViewOfFileEx、MapViewOfFileExNuma)の単一の呼び出しによって作成された、同一の初期ページ割り当ての一部であること。
すべてのページに付与されたアクセス権が同一であること(PAGE_READONLY、PAGE_READWRITE、PAGE_NOACCESS、PAGE_WRITECOPY、PAGE_EXECUTE、PAGE_EXECUTE_READ、PAGE_EXECUTE_READWRITE、PAGE_EXECUTE_WRITECOPY、PAGE_GUARD、または PAGE_NOCACHE)。

関数は領域内の先頭ページの属性を判定し、その後、ページ範囲全体をスキャンし終えるか、属性のセットが一致しないページに遭遇するまで、後続のページをスキャンします。関数は、属性が一致するページ領域の属性とサイズ(バイト単位)を返します。たとえば、40 メガバイト (MB) の空きメモリ領域があり、その領域の先頭から 10 MB の位置にあるページに対して VirtualQuery を呼び出した場合、関数は MEM_FREE の状態と 30 MB のサイズを取得します。

共有のコピーオンライトページが変更されると、そのページは変更したプロセスに固有のものになります。ただし、VirtualQuery 関数は、そのようなページを MEM_PRIVATE ではなく、MEM_MAPPED(データビューの場合)または MEM_IMAGE(実行可能イメージビューの場合)として引き続き報告します。特定のページでコピーオンライトが発生したかどうかを検出するには、そのページにアクセスするか、VirtualLock 関数を使ってロックし、ページがメモリ上に常駐していることを確認してから、QueryWorkingSetEx 関数を使用して、そのページの拡張ワーキングセット情報内の Shared ビットを確認します。Shared ビットがクリアされている場合、そのページはプライベートです。

この関数は呼び出し元プロセスのメモリ内のページ領域について報告し、VirtualQueryEx 関数は指定したプロセスのメモリ内のページ領域について報告します。

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

各言語での呼び出し定義

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

UINT_PTR VirtualQuery(
    const void* lpAddress,   // optional
    MEMORY_BASIC_INFORMATION* lpBuffer,
    UINT_PTR dwLength
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern UIntPtr VirtualQuery(
    IntPtr lpAddress,   // void* optional
    IntPtr lpBuffer,   // MEMORY_BASIC_INFORMATION* out
    UIntPtr dwLength   // UINT_PTR
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function VirtualQuery(
    lpAddress As IntPtr,   ' void* optional
    lpBuffer As IntPtr,   ' MEMORY_BASIC_INFORMATION* out
    dwLength As UIntPtr   ' UINT_PTR
) As UIntPtr
End Function

' lpAddress : void* optional
' lpBuffer : MEMORY_BASIC_INFORMATION* out
' dwLength : UINT_PTR
Declare PtrSafe Function VirtualQuery Lib "kernel32" ( _
    ByVal lpAddress As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwLength As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VirtualQuery = ctypes.windll.kernel32.VirtualQuery
VirtualQuery.restype = ctypes.c_size_t
VirtualQuery.argtypes = [
    ctypes.POINTER(None),  # lpAddress : void* optional
    ctypes.c_void_p,  # lpBuffer : MEMORY_BASIC_INFORMATION* out
    ctypes.c_size_t,  # dwLength : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
VirtualQuery = Fiddle::Function.new(
  lib['VirtualQuery'],
  [
    Fiddle::TYPE_VOIDP,  # lpAddress : void* optional
    Fiddle::TYPE_VOIDP,  # lpBuffer : MEMORY_BASIC_INFORMATION* out
    Fiddle::TYPE_UINTPTR_T,  # dwLength : UINT_PTR
  ],
  Fiddle::TYPE_UINTPTR_T)

#[link(name = "kernel32")]
extern "system" {
    fn VirtualQuery(
        lpAddress: *const (),  // void* optional
        lpBuffer: *mut MEMORY_BASIC_INFORMATION,  // MEMORY_BASIC_INFORMATION* out
        dwLength: usize  // UINT_PTR
    ) -> usize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern UIntPtr VirtualQuery(IntPtr lpAddress, IntPtr lpBuffer, UIntPtr dwLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_VirtualQuery' -Namespace Win32 -PassThru
# $api::VirtualQuery(lpAddress, lpBuffer, dwLength)

#uselib "KERNEL32.dll"
#func global VirtualQuery "VirtualQuery" sptr, sptr, sptr
; VirtualQuery lpAddress, varptr(lpBuffer), dwLength   ; 戻り値は stat
; lpAddress : void* optional -> "sptr"
; lpBuffer : MEMORY_BASIC_INFORMATION* out -> "sptr"
; dwLength : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global VirtualQuery "VirtualQuery" sptr, var, sptr
; res = VirtualQuery(lpAddress, lpBuffer, dwLength)
; lpAddress : void* optional -> "sptr"
; lpBuffer : MEMORY_BASIC_INFORMATION* out -> "var"
; dwLength : UINT_PTR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global VirtualQuery "VirtualQuery" sptr, sptr, sptr
; res = VirtualQuery(lpAddress, varptr(lpBuffer), dwLength)
; lpAddress : void* optional -> "sptr"
; lpBuffer : MEMORY_BASIC_INFORMATION* out -> "sptr"
; dwLength : UINT_PTR -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。