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

K32EmptyWorkingSet

関数
指定プロセスのワーキングセットを最小化して解放する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL K32EmptyWorkingSet(
    HANDLE hProcess
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドルです。このハンドルには PROCESS_QUERY_INFORMATION または PROCESS_QUERY_LIMITED_INFORMATION アクセス権、および PROCESS_SET_QUOTA アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したプロセスのワーキングセットから、可能な限り多くのページを削除します。

戻り値

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

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

解説(Remarks)

ワーキングセットを空にするには、SetProcessWorkingSetSize または SetProcessWorkingSetSizeEx 関数を呼び出し、dwMinimumWorkingSetSizedwMaximumWorkingSetSize パラメーターに値 (SIZE_T)(-1) を設定する方法もあります。

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

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

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

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

各言語での呼び出し定義

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

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

K32EmptyWorkingSet = ctypes.windll.kernel32.K32EmptyWorkingSet
K32EmptyWorkingSet.restype = wintypes.BOOL
K32EmptyWorkingSet.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procK32EmptyWorkingSet = kernel32.NewProc("K32EmptyWorkingSet")
)

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

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

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

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

let k32emptyworkingset =
  foreign "K32EmptyWorkingSet"
    ((ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

公式の関連項目