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

WTSEnumerateSessionsA

関数
指定サーバー上のセッションを列挙する。
DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL WTSEnumerateSessionsA(
    HANDLE hServer,   // optional
    DWORD Reserved,
    DWORD Version,
    WTS_SESSION_INFOA** ppSessionInfo,
    DWORD* pCount
);

パラメーター

名前型方向説明
hServerHANDLEoptional対象RDサーバーのハンドル。ローカルにはWTS_CURRENT_SERVER_HANDLEを指定。
ReservedDWORDin予約済み。必ず0を指定する。
VersionDWORDin要求するデータ構造のバージョン。必ず1を指定する。
ppSessionInfoWTS_SESSION_INFOA**outWTS_SESSION_INFOA配列へのポインタを受け取る(出力、WTSFreeMemoryで解放)。
pCountDWORD*out返されたセッション数を受け取るポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSEnumerateSessionsA = wtsapi32.NewProc("WTSEnumerateSessionsA")
)

// hServer (HANDLE optional), Reserved (DWORD), Version (DWORD), ppSessionInfo (WTS_SESSION_INFOA** out), pCount (DWORD* out)
r1, _, err := procWTSEnumerateSessionsA.Call(
	uintptr(hServer),
	uintptr(Reserved),
	uintptr(Version),
	uintptr(ppSessionInfo),
	uintptr(pCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSEnumerateSessionsA(
  hServer: THandle;   // HANDLE optional
  Reserved: DWORD;   // DWORD
  Version: DWORD;   // DWORD
  ppSessionInfo: Pointer;   // WTS_SESSION_INFOA** out
  pCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSEnumerateSessionsA';
result := DllCall("WTSAPI32\WTSEnumerateSessionsA"
    , "Ptr", hServer   ; HANDLE optional
    , "UInt", Reserved   ; DWORD
    , "UInt", Version   ; DWORD
    , "Ptr", ppSessionInfo   ; WTS_SESSION_INFOA** out
    , "Ptr", pCount   ; DWORD* out
    , "Int")   ; return: BOOL
●WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount) = DLL("WTSAPI32.dll", "bool WTSEnumerateSessionsA(void*, dword, dword, void*, void*)")
# 呼び出し: WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount)
# hServer : HANDLE optional -> "void*"
# Reserved : DWORD -> "dword"
# Version : DWORD -> "dword"
# ppSessionInfo : WTS_SESSION_INFOA** out -> "void*"
# pCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wtsapi32" fn WTSEnumerateSessionsA(
    hServer: ?*anyopaque, // HANDLE optional
    Reserved: u32, // DWORD
    Version: u32, // DWORD
    ppSessionInfo: [*c][*c]WTS_SESSION_INFOA, // WTS_SESSION_INFOA** out
    pCount: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WTSEnumerateSessionsA(
    hServer: pointer,  # HANDLE optional
    Reserved: uint32,  # DWORD
    Version: uint32,  # DWORD
    ppSessionInfo: ptr WTS_SESSION_INFOA,  # WTS_SESSION_INFOA** out
    pCount: ptr uint32  # DWORD* out
): int32 {.importc: "WTSEnumerateSessionsA", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSEnumerateSessionsA(
    void* hServer,   // HANDLE optional
    uint Reserved,   // DWORD
    uint Version,   // DWORD
    WTS_SESSION_INFOA** ppSessionInfo,   // WTS_SESSION_INFOA** out
    uint* pCount   // DWORD* out
);
ccall((:WTSEnumerateSessionsA, "WTSAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, Ptr{WTS_SESSION_INFOA}, Ptr{UInt32}),
      hServer, Reserved, Version, ppSessionInfo, pCount)
# hServer : HANDLE optional -> Ptr{Cvoid}
# Reserved : DWORD -> UInt32
# Version : DWORD -> UInt32
# ppSessionInfo : WTS_SESSION_INFOA** out -> Ptr{WTS_SESSION_INFOA}
# pCount : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSEnumerateSessionsA(
    void* hServer,
    uint32_t Reserved,
    uint32_t Version,
    void* ppSessionInfo,
    uint32_t* pCount);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount)
-- hServer : HANDLE optional
-- Reserved : DWORD
-- Version : DWORD
-- ppSessionInfo : WTS_SESSION_INFOA** out
-- pCount : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSEnumerateSessionsA = lib.func('__stdcall', 'WTSEnumerateSessionsA', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *', 'uint32_t *']);
// WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount)
// hServer : HANDLE optional -> 'void *'
// Reserved : DWORD -> 'uint32_t'
// Version : DWORD -> 'uint32_t'
// ppSessionInfo : WTS_SESSION_INFOA** out -> 'void *'
// pCount : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSEnumerateSessionsA: { parameters: ["pointer", "u32", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount)
// hServer : HANDLE optional -> "pointer"
// Reserved : DWORD -> "u32"
// Version : DWORD -> "u32"
// ppSessionInfo : WTS_SESSION_INFOA** out -> "pointer"
// pCount : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSEnumerateSessionsA(
    void* hServer,
    uint32_t Reserved,
    uint32_t Version,
    void* ppSessionInfo,
    uint32_t* pCount);
C, "WTSAPI32.dll");
// $ffi->WTSEnumerateSessionsA(hServer, Reserved, Version, ppSessionInfo, pCount);
// hServer : HANDLE optional
// Reserved : DWORD
// Version : DWORD
// ppSessionInfo : WTS_SESSION_INFOA** out
// pCount : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wtsapi32 extends StdCallLibrary {
    Wtsapi32 INSTANCE = Native.load("wtsapi32", Wtsapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean WTSEnumerateSessionsA(
        Pointer hServer,   // HANDLE optional
        int Reserved,   // DWORD
        int Version,   // DWORD
        Pointer ppSessionInfo,   // WTS_SESSION_INFOA** out
        IntByReference pCount   // DWORD* out
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSEnumerateSessionsA = WTSEnumerateSessionsA(
    hServer : Void*,   # HANDLE optional
    Reserved : UInt32,   # DWORD
    Version : UInt32,   # DWORD
    ppSessionInfo : WTS_SESSION_INFOA**,   # WTS_SESSION_INFOA** out
    pCount : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSEnumerateSessionsANative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef WTSEnumerateSessionsADart = int Function(Pointer<Void>, int, int, Pointer<Void>, Pointer<Uint32>);
final WTSEnumerateSessionsA = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSEnumerateSessionsANative, WTSEnumerateSessionsADart>('WTSEnumerateSessionsA');
// hServer : HANDLE optional -> Pointer<Void>
// Reserved : DWORD -> Uint32
// Version : DWORD -> Uint32
// ppSessionInfo : WTS_SESSION_INFOA** out -> Pointer<Void>
// pCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSEnumerateSessionsA(
  hServer: THandle;   // HANDLE optional
  Reserved: DWORD;   // DWORD
  Version: DWORD;   // DWORD
  ppSessionInfo: Pointer;   // WTS_SESSION_INFOA** out
  pCount: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSEnumerateSessionsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSEnumerateSessionsA"
  c_WTSEnumerateSessionsA :: Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr Word32 -> IO CInt
-- hServer : HANDLE optional -> Ptr ()
-- Reserved : DWORD -> Word32
-- Version : DWORD -> Word32
-- ppSessionInfo : WTS_SESSION_INFOA** out -> Ptr ()
-- pCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsenumeratesessionsa =
  foreign "WTSEnumerateSessionsA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hServer : HANDLE optional -> (ptr void) *)
(* Reserved : DWORD -> uint32_t *)
(* Version : DWORD -> uint32_t *)
(* ppSessionInfo : WTS_SESSION_INFOA** out -> (ptr void) *)
(* pCount : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSEnumerateSessionsA" wtsenumerate-sessions-a :convention :stdcall) :int32
  (h-server :pointer)   ; HANDLE optional
  (reserved :uint32)   ; DWORD
  (version :uint32)   ; DWORD
  (pp-session-info :pointer)   ; WTS_SESSION_INFOA** out
  (p-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSEnumerateSessionsA = Win32::API::More->new('WTSAPI32',
    'BOOL WTSEnumerateSessionsA(HANDLE hServer, DWORD Reserved, DWORD Version, LPVOID ppSessionInfo, LPVOID pCount)');
# my $ret = $WTSEnumerateSessionsA->Call($hServer, $Reserved, $Version, $ppSessionInfo, $pCount);
# hServer : HANDLE optional -> HANDLE
# Reserved : DWORD -> DWORD
# Version : DWORD -> DWORD
# ppSessionInfo : WTS_SESSION_INFOA** out -> LPVOID
# pCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
使用する型