ホーム › System.RemoteDesktop › WTSEnumerateProcessesW

WTSEnumerateProcessesW

関数

指定サーバー上のアクティブなプロセスを列挙する。

DLLWTSAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// WTSAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL WTSEnumerateProcessesW(
    HANDLE hServer,   // optional
    DWORD Reserved,
    DWORD Version,
    WTS_PROCESS_INFOW** ppProcessInfo,
    DWORD* pCount
);

パラメーター

名前	型	方向	説明
hServer	HANDLE	optional	RD セッションホストサーバーへのハンドル。WTSOpenServer 関数で開いたハンドルを指定するか、アプリケーションが実行されている RD セッションホストサーバーを示す WTS_CURRENT_SERVER_HANDLE を指定します。
Reserved	DWORD	in	予約済みです。0 を指定する必要があります。
Version	DWORD	in	列挙要求のバージョンを指定します。1 である必要があります。
ppProcessInfo	WTS_PROCESS_INFOW**	inout	WTS_PROCESS_INFO 構造体の配列へのポインターを受け取る変数へのポインター。配列内の各構造体には、指定した RD セッションホストサーバー上のアクティブなプロセスに関する情報が格納されます。返されたバッファーを解放するには、WTSFreeMemory 関数を呼び出します。
pCount	DWORD*	inout	ppProcessInfo バッファーに返された WTS_PROCESS_INFO 構造体の数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定した Remote Desktop セッションホスト (RD セッションホスト) サーバー上でアクティブなプロセスに関する情報を取得します。(Unicode)

戻り値

関数が成功すると、0 以外の値が返されます。

関数が失敗すると、0 が返されます。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

別のユーザーのコンテキストで実行されているプロセスを列挙するには、呼び出し元が Administrators グループのメンバーである必要があります。

メモ

wtsapi32.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WTSEnumerateProcesses を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立ではないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// WTSAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL WTSEnumerateProcessesW(
    HANDLE hServer,   // optional
    DWORD Reserved,
    DWORD Version,
    WTS_PROCESS_INFOW** ppProcessInfo,
    DWORD* pCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WTSEnumerateProcessesW(
    IntPtr hServer,   // HANDLE optional
    uint Reserved,   // DWORD
    uint Version,   // DWORD
    IntPtr ppProcessInfo,   // WTS_PROCESS_INFOW** in/out
    ref uint pCount   // DWORD* in/out
);

<DllImport("WTSAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSEnumerateProcessesW(
    hServer As IntPtr,   ' HANDLE optional
    Reserved As UInteger,   ' DWORD
    Version As UInteger,   ' DWORD
    ppProcessInfo As IntPtr,   ' WTS_PROCESS_INFOW** in/out
    ByRef pCount As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hServer : HANDLE optional
' Reserved : DWORD
' Version : DWORD
' ppProcessInfo : WTS_PROCESS_INFOW** in/out
' pCount : DWORD* in/out
Declare PtrSafe Function WTSEnumerateProcessesW Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByVal Reserved As Long, _
    ByVal Version As Long, _
    ByVal ppProcessInfo As LongPtr, _
    ByRef pCount As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WTSEnumerateProcessesW = ctypes.windll.wtsapi32.WTSEnumerateProcessesW
WTSEnumerateProcessesW.restype = wintypes.BOOL
WTSEnumerateProcessesW.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    wintypes.DWORD,  # Reserved : DWORD
    wintypes.DWORD,  # Version : DWORD
    ctypes.c_void_p,  # ppProcessInfo : WTS_PROCESS_INFOW** in/out
    ctypes.POINTER(wintypes.DWORD),  # pCount : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSEnumerateProcessesW = Fiddle::Function.new(
  lib['WTSEnumerateProcessesW'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    -Fiddle::TYPE_INT,  # Reserved : DWORD
    -Fiddle::TYPE_INT,  # Version : DWORD
    Fiddle::TYPE_VOIDP,  # ppProcessInfo : WTS_PROCESS_INFOW** in/out
    Fiddle::TYPE_VOIDP,  # pCount : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wtsapi32")]
extern "system" {
    fn WTSEnumerateProcessesW(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        Reserved: u32,  // DWORD
        Version: u32,  // DWORD
        ppProcessInfo: *mut *mut WTS_PROCESS_INFOW,  // WTS_PROCESS_INFOW** in/out
        pCount: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool WTSEnumerateProcessesW(IntPtr hServer, uint Reserved, uint Version, IntPtr ppProcessInfo, ref uint pCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSEnumerateProcessesW' -Namespace Win32 -PassThru
# $api::WTSEnumerateProcessesW(hServer, Reserved, Version, ppProcessInfo, pCount)

#uselib "WTSAPI32.dll"
#func global WTSEnumerateProcessesW "WTSEnumerateProcessesW" wptr, wptr, wptr, wptr, wptr
; WTSEnumerateProcessesW hServer, Reserved, Version, varptr(ppProcessInfo), varptr(pCount)   ; 戻り値は stat
; hServer : HANDLE optional -> "wptr"
; Reserved : DWORD -> "wptr"
; Version : DWORD -> "wptr"
; ppProcessInfo : WTS_PROCESS_INFOW** in/out -> "wptr"
; pCount : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateProcessesW "WTSEnumerateProcessesW" sptr, int, int, var, var
; res = WTSEnumerateProcessesW(hServer, Reserved, Version, ppProcessInfo, pCount)
; hServer : HANDLE optional -> "sptr"
; Reserved : DWORD -> "int"
; Version : DWORD -> "int"
; ppProcessInfo : WTS_PROCESS_INFOW** in/out -> "var"
; pCount : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateProcessesW "WTSEnumerateProcessesW" sptr, int, int, sptr, sptr
; res = WTSEnumerateProcessesW(hServer, Reserved, Version, varptr(ppProcessInfo), varptr(pCount))
; hServer : HANDLE optional -> "sptr"
; Reserved : DWORD -> "int"
; Version : DWORD -> "int"
; ppProcessInfo : WTS_PROCESS_INFOW** in/out -> "sptr"
; pCount : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。