ホーム › System.ProcessStatus › K32EnumProcesses

K32EnumProcesses

関数

実行中の各プロセスの識別子を列挙して取得する。

DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL K32EnumProcesses(
    DWORD* lpidProcess,
    DWORD cb,
    DWORD* lpcbNeeded
);

パラメーター

名前	型	方向	説明
lpidProcess	DWORD*	out	プロセス識別子のリストを受け取る配列へのポインター。
cb	DWORD	in	pProcessIds 配列のサイズ(バイト単位)。
lpcbNeeded	DWORD*	out	pProcessIds 配列に返されたバイト数。

戻り値の型: BOOL

公式ドキュメント

システム内の各プロセスオブジェクトのプロセス識別子を取得します。

戻り値

関数が成功すると、戻り値はゼロ以外です。

関数が失敗すると、戻り値はゼロです。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

EnumProcesses を呼び出す時点でプロセスがいくつ存在するかを予測するのは難しいため、大きな配列を使用することをお勧めします。

列挙されたプロセス数を求めるには、lpcbNeeded の値を sizeof(DWORD) で除算します。すべてのプロセス識別子を格納するにはバッファーが小さすぎる場合でも、その旨は通知されません。したがって、lpcbNeeded が cb と等しい場合は、より大きな配列で呼び出しを再試行することを検討してください。

取得したばかりの識別子に対応するプロセスのプロセスハンドルを取得するには、OpenProcess 関数を呼び出します。

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

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

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

使用例

例については、 Enumerating All Processes または Enumerating All Modules for a Process を参照してください。

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

各言語での呼び出し定義

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

BOOL K32EnumProcesses(
    DWORD* lpidProcess,
    DWORD cb,
    DWORD* lpcbNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool K32EnumProcesses(
    out uint lpidProcess,   // DWORD* out
    uint cb,   // DWORD
    out uint lpcbNeeded   // DWORD* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function K32EnumProcesses(
    <Out> ByRef lpidProcess As UInteger,   ' DWORD* out
    cb As UInteger,   ' DWORD
    <Out> ByRef lpcbNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpidProcess : DWORD* out
' cb : DWORD
' lpcbNeeded : DWORD* out
Declare PtrSafe Function K32EnumProcesses Lib "kernel32" ( _
    ByRef lpidProcess As Long, _
    ByVal cb As Long, _
    ByRef lpcbNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

K32EnumProcesses = ctypes.windll.kernel32.K32EnumProcesses
K32EnumProcesses.restype = wintypes.BOOL
K32EnumProcesses.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpidProcess : DWORD* out
    wintypes.DWORD,  # cb : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpcbNeeded : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
K32EnumProcesses = Fiddle::Function.new(
  lib['K32EnumProcesses'],
  [
    Fiddle::TYPE_VOIDP,  # lpidProcess : DWORD* out
    -Fiddle::TYPE_INT,  # cb : DWORD
    Fiddle::TYPE_VOIDP,  # lpcbNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn K32EnumProcesses(
        lpidProcess: *mut u32,  // DWORD* out
        cb: u32,  // DWORD
        lpcbNeeded: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool K32EnumProcesses(out uint lpidProcess, uint cb, out uint lpcbNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_K32EnumProcesses' -Namespace Win32 -PassThru
# $api::K32EnumProcesses(lpidProcess, cb, lpcbNeeded)

#uselib "KERNEL32.dll"
#func global K32EnumProcesses "K32EnumProcesses" sptr, sptr, sptr
; K32EnumProcesses varptr(lpidProcess), cb, varptr(lpcbNeeded)   ; 戻り値は stat
; lpidProcess : DWORD* out -> "sptr"
; cb : DWORD -> "sptr"
; lpcbNeeded : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global K32EnumProcesses "K32EnumProcesses" var, int, var
; res = K32EnumProcesses(lpidProcess, cb, lpcbNeeded)
; lpidProcess : DWORD* out -> "var"
; cb : DWORD -> "int"
; lpcbNeeded : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global K32EnumProcesses "K32EnumProcesses" sptr, int, sptr
; res = K32EnumProcesses(varptr(lpidProcess), cb, varptr(lpcbNeeded))
; lpidProcess : DWORD* out -> "sptr"
; cb : DWORD -> "int"
; lpcbNeeded : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。