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

QueryWorkingSetEx

関数
指定プロセスのワーキングセット情報を拡張形式で取得する。
DLLPSAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL QueryWorkingSetEx(
    HANDLE hProcess,
    void* pv,
    DWORD cb
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドルです。このハンドルは PROCESS_QUERY_INFORMATION アクセス権を持っている必要があります。詳細については、Process Security and Access Rights を参照してください。
pvvoid*outPSAPI_WORKING_SET_EX_INFORMATION 構造体の配列へのポインターです。入力時には、配列の各要素が対象とする仮想アドレスを指定します。出力時には、配列の各要素が対応する仮想ページに関する情報を受け取ります。
cbDWORDinpv バッファーのサイズ(バイト単位)です。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのアドレス空間内の特定の仮想アドレスにあるページについて、拡張情報を取得します。

戻り値

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

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

解説(Remarks)

対象プロセスのワーキングセットに限定される QueryWorkingSet 関数とは異なり、QueryWorkingSetEx 関数を使用すると、プロセスのワーキングセットには含まれないものの、AWE や large page のようにプロセスの一部であるアドレスを照会できます。

Windows 7 および Windows Server 2008 R2 以降、Psapi.h は PSAPI 関数のバージョン番号を定めています。PSAPI のバージョン番号は、関数を呼び出す際に使用する名前と、プログラムが読み込む必要のあるライブラリに影響します。

PSAPI_VERSION が 2 以上の場合、この関数は Psapi.h で K32QueryWorkingSetEx として定義され、Kernel32.lib および Kernel32.dll でエクスポートされます。PSAPI_VERSION が 1 の場合、この関数は Psapi.h で QueryWorkingSetEx として定義され、K32QueryWorkingSetEx を呼び出すラッパーとして Psapi.lib および Psapi.dll でエクスポートされます。

Windows 7 以降のバージョンに加えて、それ以前のバージョンの Windows でも実行する必要があるプログラムは、常にこの関数を QueryWorkingSetEx として呼び出してください。シンボルが正しく解決されるようにするには、TARGETLIBS マクロに Psapi.lib を追加し、「–DPSAPI_VERSION=1」を指定してプログラムをコンパイルしてください。実行時の動的リンクを使用するには、Psapi.dll を読み込んでください。

使用例

例については、Allocating Memory from a NUMA Node を参照してください。

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

各言語での呼び出し定義

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

BOOL QueryWorkingSetEx(
    HANDLE hProcess,
    void* pv,
    DWORD cb
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("PSAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryWorkingSetEx(
    IntPtr hProcess,   // HANDLE
    IntPtr pv,   // void* out
    uint cb   // DWORD
);
<DllImport("PSAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryWorkingSetEx(
    hProcess As IntPtr,   ' HANDLE
    pv As IntPtr,   ' void* out
    cb As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' pv : void* out
' cb : DWORD
Declare PtrSafe Function QueryWorkingSetEx Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal pv As LongPtr, _
    ByVal cb As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueryWorkingSetEx = ctypes.windll.psapi.QueryWorkingSetEx
QueryWorkingSetEx.restype = wintypes.BOOL
QueryWorkingSetEx.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # pv : void* out
    wintypes.DWORD,  # cb : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	psapi = windows.NewLazySystemDLL("PSAPI.dll")
	procQueryWorkingSetEx = psapi.NewProc("QueryWorkingSetEx")
)

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

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

typedef QueryWorkingSetExNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef QueryWorkingSetExDart = int Function(Pointer<Void>, Pointer<Void>, int);
final QueryWorkingSetEx = DynamicLibrary.open('PSAPI.dll')
    .lookupFunction<QueryWorkingSetExNative, QueryWorkingSetExDart>('QueryWorkingSetEx');
// hProcess : HANDLE -> Pointer<Void>
// pv : void* out -> Pointer<Void>
// cb : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueryWorkingSetEx(
  hProcess: THandle;   // HANDLE
  pv: Pointer;   // void* out
  cb: DWORD   // DWORD
): BOOL; stdcall;
  external 'PSAPI.dll' name 'QueryWorkingSetEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryWorkingSetEx"
  c_QueryWorkingSetEx :: Ptr () -> Ptr () -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- pv : void* out -> Ptr ()
-- cb : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let queryworkingsetex =
  foreign "QueryWorkingSetEx"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* pv : void* out -> (ptr void) *)
(* cb : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library psapi (t "PSAPI.dll"))
(cffi:use-foreign-library psapi)

(cffi:defcfun ("QueryWorkingSetEx" query-working-set-ex :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (pv :pointer)   ; void* out
  (cb :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueryWorkingSetEx = Win32::API::More->new('PSAPI',
    'BOOL QueryWorkingSetEx(HANDLE hProcess, LPVOID pv, DWORD cb)');
# my $ret = $QueryWorkingSetEx->Call($hProcess, $pv, $cb);
# hProcess : HANDLE -> HANDLE
# pv : void* out -> LPVOID
# cb : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目