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

WTSEnumerateSessionsExW

関数
フィルター指定で指定サーバーのセッションを列挙する。
DLLWTSAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL WTSEnumerateSessionsExW(
    HANDLE hServer,   // optional
    DWORD* pLevel,
    DWORD Filter,
    WTS_SESSION_INFO_1W** ppSessionInfo,
    DWORD* pCount
);

パラメーター

名前方向
hServerHANDLEinoptional
pLevelDWORD*inout
FilterDWORDin
ppSessionInfoWTS_SESSION_INFO_1W**out
pCountDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WTSEnumerateSessionsExW(
    HANDLE hServer,   // optional
    DWORD* pLevel,
    DWORD Filter,
    WTS_SESSION_INFO_1W** ppSessionInfo,
    DWORD* pCount
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WTSEnumerateSessionsExW(
    IntPtr hServer,   // HANDLE optional
    ref uint pLevel,   // DWORD* in/out
    uint Filter,   // DWORD
    IntPtr ppSessionInfo,   // WTS_SESSION_INFO_1W** out
    out uint pCount   // DWORD* out
);
<DllImport("WTSAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSEnumerateSessionsExW(
    hServer As IntPtr,   ' HANDLE optional
    ByRef pLevel As UInteger,   ' DWORD* in/out
    Filter As UInteger,   ' DWORD
    ppSessionInfo As IntPtr,   ' WTS_SESSION_INFO_1W** out
    <Out> ByRef pCount As UInteger   ' DWORD* out
) As Boolean
End Function
' hServer : HANDLE optional
' pLevel : DWORD* in/out
' Filter : DWORD
' ppSessionInfo : WTS_SESSION_INFO_1W** out
' pCount : DWORD* out
Declare PtrSafe Function WTSEnumerateSessionsExW Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByRef pLevel As Long, _
    ByVal Filter As Long, _
    ByVal ppSessionInfo 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

WTSEnumerateSessionsExW = ctypes.windll.wtsapi32.WTSEnumerateSessionsExW
WTSEnumerateSessionsExW.restype = wintypes.BOOL
WTSEnumerateSessionsExW.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    ctypes.POINTER(wintypes.DWORD),  # pLevel : DWORD* in/out
    wintypes.DWORD,  # Filter : DWORD
    ctypes.c_void_p,  # ppSessionInfo : WTS_SESSION_INFO_1W** out
    ctypes.POINTER(wintypes.DWORD),  # pCount : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSEnumerateSessionsExW = Fiddle::Function.new(
  lib['WTSEnumerateSessionsExW'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pLevel : DWORD* in/out
    -Fiddle::TYPE_INT,  # Filter : DWORD
    Fiddle::TYPE_VOIDP,  # ppSessionInfo : WTS_SESSION_INFO_1W** out
    Fiddle::TYPE_VOIDP,  # pCount : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSEnumerateSessionsExW(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        pLevel: *mut u32,  // DWORD* in/out
        Filter: u32,  // DWORD
        ppSessionInfo: *mut *mut WTS_SESSION_INFO_1W,  // WTS_SESSION_INFO_1W** out
        pCount: *mut u32  // DWORD* 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 WTSEnumerateSessionsExW(IntPtr hServer, ref uint pLevel, uint Filter, IntPtr ppSessionInfo, out uint pCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSEnumerateSessionsExW' -Namespace Win32 -PassThru
# $api::WTSEnumerateSessionsExW(hServer, pLevel, Filter, ppSessionInfo, pCount)
#uselib "WTSAPI32.dll"
#func global WTSEnumerateSessionsExW "WTSEnumerateSessionsExW" wptr, wptr, wptr, wptr, wptr
; WTSEnumerateSessionsExW hServer, varptr(pLevel), Filter, varptr(ppSessionInfo), varptr(pCount)   ; 戻り値は stat
; hServer : HANDLE optional -> "wptr"
; pLevel : DWORD* in/out -> "wptr"
; Filter : DWORD -> "wptr"
; ppSessionInfo : WTS_SESSION_INFO_1W** out -> "wptr"
; pCount : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateSessionsExW "WTSEnumerateSessionsExW" sptr, var, int, var, var
; res = WTSEnumerateSessionsExW(hServer, pLevel, Filter, ppSessionInfo, pCount)
; hServer : HANDLE optional -> "sptr"
; pLevel : DWORD* in/out -> "var"
; Filter : DWORD -> "int"
; ppSessionInfo : WTS_SESSION_INFO_1W** out -> "var"
; pCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WTSEnumerateSessionsExW(HANDLE hServer, DWORD* pLevel, DWORD Filter, WTS_SESSION_INFO_1W** ppSessionInfo, DWORD* pCount)
#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateSessionsExW "WTSEnumerateSessionsExW" intptr, var, int, var, var
; res = WTSEnumerateSessionsExW(hServer, pLevel, Filter, ppSessionInfo, pCount)
; hServer : HANDLE optional -> "intptr"
; pLevel : DWORD* in/out -> "var"
; Filter : DWORD -> "int"
; ppSessionInfo : WTS_SESSION_INFO_1W** out -> "var"
; pCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSEnumerateSessionsExW = wtsapi32.NewProc("WTSEnumerateSessionsExW")
)

// hServer (HANDLE optional), pLevel (DWORD* in/out), Filter (DWORD), ppSessionInfo (WTS_SESSION_INFO_1W** out), pCount (DWORD* out)
r1, _, err := procWTSEnumerateSessionsExW.Call(
	uintptr(hServer),
	uintptr(pLevel),
	uintptr(Filter),
	uintptr(ppSessionInfo),
	uintptr(pCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSEnumerateSessionsExW(
  hServer: THandle;   // HANDLE optional
  pLevel: Pointer;   // DWORD* in/out
  Filter: DWORD;   // DWORD
  ppSessionInfo: Pointer;   // WTS_SESSION_INFO_1W** out
  pCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSEnumerateSessionsExW';
result := DllCall("WTSAPI32\WTSEnumerateSessionsExW"
    , "Ptr", hServer   ; HANDLE optional
    , "Ptr", pLevel   ; DWORD* in/out
    , "UInt", Filter   ; DWORD
    , "Ptr", ppSessionInfo   ; WTS_SESSION_INFO_1W** out
    , "Ptr", pCount   ; DWORD* out
    , "Int")   ; return: BOOL
●WTSEnumerateSessionsExW(hServer, pLevel, Filter, ppSessionInfo, pCount) = DLL("WTSAPI32.dll", "bool WTSEnumerateSessionsExW(void*, void*, dword, void*, void*)")
# 呼び出し: WTSEnumerateSessionsExW(hServer, pLevel, Filter, ppSessionInfo, pCount)
# hServer : HANDLE optional -> "void*"
# pLevel : DWORD* in/out -> "void*"
# Filter : DWORD -> "dword"
# ppSessionInfo : WTS_SESSION_INFO_1W** out -> "void*"
# pCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。