ホーム › System.RemoteDesktop › WTSEnumerateListenersW

WTSEnumerateListenersW

関数

指定サーバー上のリスナーを列挙する。

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

シグネチャ

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

BOOL WTSEnumerateListenersW(
    HANDLE hServer,   // optional
    void* pReserved,
    DWORD Reserved,
    WORD** pListeners,   // optional
    DWORD* pCount
);

パラメーター

名前	型	方向	説明
hServer	HANDLE	inoptional	RD セッションホストサーバーへのハンドル。このパラメーターには常に WTS_CURRENT_SERVER_HANDLE を設定してください。
pReserved	void*	in	このパラメーターは予約されています。このパラメーターには常に NULL を設定してください。
Reserved	DWORD	in	このパラメーターは予約されています。このパラメーターには常に 0 を設定してください。
pListeners	WORD**	outoptional	リスナーの名前を受け取る WTSLISTENERNAME 変数の配列へのポインター。
pCount	DWORD*	inout	pListeners パラメーターが参照する配列内のリスナー名の数が格納される DWORD 変数へのポインター。リスナー名の数が不明な場合は、pListeners に NULL を渡してください。この関数は、 pListeners パラメーターが指す配列に割り当てる必要がある WTSLISTENERNAME 変数の数を返します。

戻り値の型: BOOL

公式ドキュメント

リモートデスクトップセッションホスト (RD セッションホスト) サーバー上のすべてのリモートデスクトップサービスリスナーを列挙します。(Unicode)

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

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

解説(Remarks)

この関数は、Remote Desktop Protocol (RDP) をサポートしないリスナーを含め、サーバー上で現在実行されているすべてのリスナーを返します。

リスナーの数が不明な場合は、pListeners に NULL を設定してこの関数を呼び出すことができます。その場合、この関数は、すべてのリスナーを受け取るために必要な WTSLISTENERNAME 変数の数を pCount パラメーターで返します。この数に基づいて pListeners 用の配列を割り当て、pListeners に新しく割り当てた配列を、 pCount に最初の呼び出しで返された数を設定して、再度この関数を呼び出してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WTSEnumerateListenersW(
    HANDLE hServer,   // optional
    void* pReserved,
    DWORD Reserved,
    WORD** pListeners,   // optional
    DWORD* pCount
);

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

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

' hServer : HANDLE optional
' pReserved : void*
' Reserved : DWORD
' pListeners : WORD** optional, out
' pCount : DWORD* in/out
Declare PtrSafe Function WTSEnumerateListenersW Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByVal pReserved As LongPtr, _
    ByVal Reserved As Long, _
    ByVal pListeners 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

WTSEnumerateListenersW = ctypes.windll.wtsapi32.WTSEnumerateListenersW
WTSEnumerateListenersW.restype = wintypes.BOOL
WTSEnumerateListenersW.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    ctypes.POINTER(None),  # pReserved : void*
    wintypes.DWORD,  # Reserved : DWORD
    ctypes.c_void_p,  # pListeners : WORD** optional, 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')
WTSEnumerateListenersW = Fiddle::Function.new(
  lib['WTSEnumerateListenersW'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pReserved : void*
    -Fiddle::TYPE_INT,  # Reserved : DWORD
    Fiddle::TYPE_VOIDP,  # pListeners : WORD** optional, 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 WTSEnumerateListenersW(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        pReserved: *mut (),  // void*
        Reserved: u32,  // DWORD
        pListeners: *mut *mut u16,  // WORD** optional, 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 WTSEnumerateListenersW(IntPtr hServer, IntPtr pReserved, uint Reserved, IntPtr pListeners, ref uint pCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSEnumerateListenersW' -Namespace Win32 -PassThru
# $api::WTSEnumerateListenersW(hServer, pReserved, Reserved, pListeners, pCount)

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

出力引数:

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