ホーム › System.RemoteDesktop › WTSEnumerateSessionsExA

WTSEnumerateSessionsExA

関数

フィルター指定で指定サーバーのセッションを列挙する。

DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSEnumerateSessionsExA(
    HANDLE hServer,   // optional
    DWORD* pLevel,
    DWORD Filter,
    WTS_SESSION_INFO_1A** ppSessionInfo,
    DWORD* pCount
);

パラメーター

名前	型	方向	説明
hServer	HANDLE	inoptional	対象サーバーへのハンドル。 WTSOpenServer 関数または WTSOpenServerEx 関数が返したハンドルを指定します。アプリケーションが実行されている RD セッションホストサーバー上のセッションを列挙するには、WTS_CURRENT_SERVER_HANDLE を指定します。
pLevel	DWORD*	inout	このパラメーターは予約されています。常に 1 を設定してください。出力時に WTSEnumerateSessionsEx がこのパラメーターの値を変更することはありません。
Filter	DWORD	in	このパラメーターは予約されています。常に 0 を設定してください。
ppSessionInfo	WTS_SESSION_INFO_1A**	out	WTS_SESSION_INFO_1 構造体の配列へのポインターを受け取る PWTS_SESSION_INFO_1 変数へのポインター。配列内の各構造体には、指定した RD セッションホストサーバー上のセッションに関する情報が格納されます。WTSOpenServerEx 関数を呼び出して RD 仮想化ホストサーバーへのハンドルを取得した場合、配列にはそのサーバー上の仮想マシンのセッションに関する情報が格納されます。配列の使用が終わったら、WTSFreeMemoryEx 関数を呼び出して解放してください。あわせて、ポインターに NULL を設定してください。
pCount	DWORD*	out	ppSessionInfo バッファーに返された WTS_SESSION_INFO_1 構造体の数を受け取る DWORD 変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定されたリモートデスクトップセッションホスト (RD セッションホスト) サーバー、またはリモートデスクトップ仮想化ホスト (RD 仮想化ホスト) サーバー上のセッションの一覧を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

RD 仮想化ホストサーバー上の仮想マシンで実行されているセッションに関する情報を取得するには、WTSOpenServerEx 関数を呼び出してハンドルを取得する必要があります。返されたバッファーを解放するには、 WTSFreeMemoryEx 関数を呼び出し、WTSClassType パラメーターに WTSTypeSessionInfoLevel1 を設定してください。

セッションを列挙するには、そのセッションに対する Query Information 権限が必要です。詳細については、 Remote Desktop Services Permissions を参照してください。セッションの権限を変更するには、リモートデスクトップサービス構成の管理ツールを使用します。

RD 仮想化ホストサーバーでホストされている仮想マシン上で実行されているセッションを列挙するには、その RD 仮想化ホストサーバーの Administrators グループのメンバーである必要があります。

メモ

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

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

各言語での呼び出し定義

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSEnumerateSessionsExA(
    HANDLE hServer,   // optional
    DWORD* pLevel,
    DWORD Filter,
    WTS_SESSION_INFO_1A** ppSessionInfo,
    DWORD* pCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WTSEnumerateSessionsExA(
    IntPtr hServer,   // HANDLE optional
    ref uint pLevel,   // DWORD* in/out
    uint Filter,   // DWORD
    IntPtr ppSessionInfo,   // WTS_SESSION_INFO_1A** out
    out uint pCount   // DWORD* out
);

<DllImport("WTSAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSEnumerateSessionsExA(
    hServer As IntPtr,   ' HANDLE optional
    ByRef pLevel As UInteger,   ' DWORD* in/out
    Filter As UInteger,   ' DWORD
    ppSessionInfo As IntPtr,   ' WTS_SESSION_INFO_1A** out
    <Out> ByRef pCount As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hServer : HANDLE optional
' pLevel : DWORD* in/out
' Filter : DWORD
' ppSessionInfo : WTS_SESSION_INFO_1A** out
' pCount : DWORD* out
Declare PtrSafe Function WTSEnumerateSessionsExA Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByRef pLevel As Long, _
    ByVal Filter As Long, _
    ByVal ppSessionInfo As LongPtr, _
    ByRef pCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WTSEnumerateSessionsExA = ctypes.windll.wtsapi32.WTSEnumerateSessionsExA
WTSEnumerateSessionsExA.restype = wintypes.BOOL
WTSEnumerateSessionsExA.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_1A** 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')
WTSEnumerateSessionsExA = Fiddle::Function.new(
  lib['WTSEnumerateSessionsExA'],
  [
    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_1A** out
    Fiddle::TYPE_VOIDP,  # pCount : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wtsapi32")]
extern "system" {
    fn WTSEnumerateSessionsExA(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        pLevel: *mut u32,  // DWORD* in/out
        Filter: u32,  // DWORD
        ppSessionInfo: *mut *mut WTS_SESSION_INFO_1A,  // WTS_SESSION_INFO_1A** 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.Ansi, SetLastError = true)]
public static extern bool WTSEnumerateSessionsExA(IntPtr hServer, ref uint pLevel, uint Filter, IntPtr ppSessionInfo, out uint pCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSEnumerateSessionsExA' -Namespace Win32 -PassThru
# $api::WTSEnumerateSessionsExA(hServer, pLevel, Filter, ppSessionInfo, pCount)

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

出力引数:

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