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

WTSEnumerateServersA

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

シグネチャ

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

BOOL WTSEnumerateServersA(
    LPSTR pDomainName,
    DWORD Reserved,
    DWORD Version,
    WTS_SERVER_INFOA** ppServerInfo,
    DWORD* pCount
);

パラメーター

名前方向
pDomainNameLPSTRin
ReservedDWORDin
VersionDWORDin
ppServerInfoWTS_SERVER_INFOA**out
pCountDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSEnumerateServersA = wtsapi32.NewProc("WTSEnumerateServersA")
)

// pDomainName (LPSTR), Reserved (DWORD), Version (DWORD), ppServerInfo (WTS_SERVER_INFOA** out), pCount (DWORD* out)
r1, _, err := procWTSEnumerateServersA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pDomainName))),
	uintptr(Reserved),
	uintptr(Version),
	uintptr(ppServerInfo),
	uintptr(pCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSEnumerateServersA(
  pDomainName: PAnsiChar;   // LPSTR
  Reserved: DWORD;   // DWORD
  Version: DWORD;   // DWORD
  ppServerInfo: Pointer;   // WTS_SERVER_INFOA** out
  pCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSEnumerateServersA';
result := DllCall("WTSAPI32\WTSEnumerateServersA"
    , "AStr", pDomainName   ; LPSTR
    , "UInt", Reserved   ; DWORD
    , "UInt", Version   ; DWORD
    , "Ptr", ppServerInfo   ; WTS_SERVER_INFOA** out
    , "Ptr", pCount   ; DWORD* out
    , "Int")   ; return: BOOL
●WTSEnumerateServersA(pDomainName, Reserved, Version, ppServerInfo, pCount) = DLL("WTSAPI32.dll", "bool WTSEnumerateServersA(char*, dword, dword, void*, void*)")
# 呼び出し: WTSEnumerateServersA(pDomainName, Reserved, Version, ppServerInfo, pCount)
# pDomainName : LPSTR -> "char*"
# Reserved : DWORD -> "dword"
# Version : DWORD -> "dword"
# ppServerInfo : WTS_SERVER_INFOA** out -> "void*"
# pCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。