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

WTSEnumerateServersW

関数
ドメイン内のリモートデスクトップサーバーを列挙する。
DLLWTSAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL WTSEnumerateServersW(
    LPWSTR pDomainName,
    DWORD Reserved,
    DWORD Version,
    WTS_SERVER_INFOW** ppServerInfo,
    DWORD* pCount
);

パラメーター

名前方向
pDomainNameLPWSTRin
ReservedDWORDin
VersionDWORDin
ppServerInfoWTS_SERVER_INFOW**out
pCountDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WTSEnumerateServersW(
    LPWSTR pDomainName,
    DWORD Reserved,
    DWORD Version,
    WTS_SERVER_INFOW** ppServerInfo,
    DWORD* pCount
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WTSEnumerateServersW(
    [MarshalAs(UnmanagedType.LPWStr)] string pDomainName,   // LPWSTR
    uint Reserved,   // DWORD
    uint Version,   // DWORD
    IntPtr ppServerInfo,   // WTS_SERVER_INFOW** out
    out uint pCount   // DWORD* out
);
<DllImport("WTSAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSEnumerateServersW(
    <MarshalAs(UnmanagedType.LPWStr)> pDomainName As String,   ' LPWSTR
    Reserved As UInteger,   ' DWORD
    Version As UInteger,   ' DWORD
    ppServerInfo As IntPtr,   ' WTS_SERVER_INFOW** out
    <Out> ByRef pCount As UInteger   ' DWORD* out
) As Boolean
End Function
' pDomainName : LPWSTR
' Reserved : DWORD
' Version : DWORD
' ppServerInfo : WTS_SERVER_INFOW** out
' pCount : DWORD* out
Declare PtrSafe Function WTSEnumerateServersW Lib "wtsapi32" ( _
    ByVal pDomainName As LongPtr, _
    ByVal Reserved As Long, _
    ByVal Version As Long, _
    ByVal ppServerInfo 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

WTSEnumerateServersW = ctypes.windll.wtsapi32.WTSEnumerateServersW
WTSEnumerateServersW.restype = wintypes.BOOL
WTSEnumerateServersW.argtypes = [
    wintypes.LPCWSTR,  # pDomainName : LPWSTR
    wintypes.DWORD,  # Reserved : DWORD
    wintypes.DWORD,  # Version : DWORD
    ctypes.c_void_p,  # ppServerInfo : WTS_SERVER_INFOW** 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')
WTSEnumerateServersW = Fiddle::Function.new(
  lib['WTSEnumerateServersW'],
  [
    Fiddle::TYPE_VOIDP,  # pDomainName : LPWSTR
    -Fiddle::TYPE_INT,  # Reserved : DWORD
    -Fiddle::TYPE_INT,  # Version : DWORD
    Fiddle::TYPE_VOIDP,  # ppServerInfo : WTS_SERVER_INFOW** 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 WTSEnumerateServersW(
        pDomainName: *mut u16,  // LPWSTR
        Reserved: u32,  // DWORD
        Version: u32,  // DWORD
        ppServerInfo: *mut *mut WTS_SERVER_INFOW,  // WTS_SERVER_INFOW** 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 WTSEnumerateServersW([MarshalAs(UnmanagedType.LPWStr)] string pDomainName, uint Reserved, uint Version, IntPtr ppServerInfo, out uint pCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSEnumerateServersW' -Namespace Win32 -PassThru
# $api::WTSEnumerateServersW(pDomainName, Reserved, Version, ppServerInfo, pCount)
#uselib "WTSAPI32.dll"
#func global WTSEnumerateServersW "WTSEnumerateServersW" wptr, wptr, wptr, wptr, wptr
; WTSEnumerateServersW pDomainName, Reserved, Version, varptr(ppServerInfo), varptr(pCount)   ; 戻り値は stat
; pDomainName : LPWSTR -> "wptr"
; Reserved : DWORD -> "wptr"
; Version : DWORD -> "wptr"
; ppServerInfo : WTS_SERVER_INFOW** out -> "wptr"
; pCount : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateServersW "WTSEnumerateServersW" wstr, int, int, var, var
; res = WTSEnumerateServersW(pDomainName, Reserved, Version, ppServerInfo, pCount)
; pDomainName : LPWSTR -> "wstr"
; Reserved : DWORD -> "int"
; Version : DWORD -> "int"
; ppServerInfo : WTS_SERVER_INFOW** out -> "var"
; pCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WTSEnumerateServersW(LPWSTR pDomainName, DWORD Reserved, DWORD Version, WTS_SERVER_INFOW** ppServerInfo, DWORD* pCount)
#uselib "WTSAPI32.dll"
#cfunc global WTSEnumerateServersW "WTSEnumerateServersW" wstr, int, int, var, var
; res = WTSEnumerateServersW(pDomainName, Reserved, Version, ppServerInfo, pCount)
; pDomainName : LPWSTR -> "wstr"
; Reserved : DWORD -> "int"
; Version : DWORD -> "int"
; ppServerInfo : WTS_SERVER_INFOW** out -> "var"
; pCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSEnumerateServersW = wtsapi32.NewProc("WTSEnumerateServersW")
)

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