Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
hServerHANDLEinoptional
pReservedvoid*in
ReservedDWORDin
pListenersWORD**outoptional
pCountDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL WTSEnumerateListenersW(HANDLE hServer, void* pReserved, DWORD Reserved, WORD** pListeners, DWORD* pCount)
#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateListenersW "WTSEnumerateListenersW" intptr, intptr, int, var, var
; res = WTSEnumerateListenersW(hServer, pReserved, Reserved, pListeners, pCount)
; hServer : HANDLE optional -> "intptr"
; pReserved : void* -> "intptr"
; Reserved : DWORD -> "int"
; pListeners : WORD** optional, out -> "var"
; pCount : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSEnumerateListenersW = wtsapi32.NewProc("WTSEnumerateListenersW")
)

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