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

WTS_SESSION_INFO_1W

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 56 バイト / x86: 32 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
ExecEnvIdDWORD4+0+0WTSEnumerateSessionsEx 関数が返すセッションの一覧の中で、そのセッションを一意に識別する識別子です。詳細については、「解説」を参照してください。
StateWTS_CONNECTSTATE_CLASS4+4+4Remote Desktop Services セッションの接続状態を指定する WTS_CONNECTSTATE_CLASS 列挙型の値です。
SessionIdDWORD4+8+8RD セッション ホスト サーバー、RD 仮想化ホスト サーバー、または仮想マシンによって割り当てられたセッション識別子です。
pSessionNameLPWSTR8/4+16+12このセッションの名前を格納する、null 終端文字列へのポインターです。たとえば、"services"、"console"、"RDP-Tcp#0" などです。
pHostNameLPWSTR8/4+24+16セッションが実行されているコンピューターの名前を格納する、null 終端文字列へのポインターです。セッションが RD セッション ホスト サーバーまたは RD 仮想化ホスト サーバー上で直接実行されている場合、この文字列は NULL になります。セッションが仮想マシン上で実行されている場合は、その仮想マシンの名前が格納されます。
pUserNameLPWSTR8/4+32+20セッションにログオンしているユーザーの名前を格納する、null 終端文字列へのポインターです。セッションにログオンしているユーザーがいない場合、この文字列は NULL になります。
pDomainNameLPWSTR8/4+40+24セッションにログオンしているユーザーのドメイン名を格納する、null 終端文字列へのポインターです。セッションにログオンしているユーザーがいない場合、この文字列は NULL になります。
pFarmNameLPWSTR8/4+48+28仮想マシンが参加しているファームの名前を格納する、null 終端文字列へのポインターです。セッションが、ファームに参加している仮想マシン上で実行されていない場合、この文字列は NULL になります。

公式ドキュメント

リモート デスクトップ セッション ホスト (RD セッション ホスト) サーバーまたはリモート デスクトップ仮想化ホスト (RD 仮想化ホスト) サーバー上のクライアント セッションに関する拡張情報を格納します。

解説(Remarks)

WTSEnumerateSessionsEx 関数は、WTSOpenServerEx 関数を呼び出して取得した RD 仮想化ホスト サーバーのハンドルを指定して呼び出した場合に、この構造体を返します。この場合、WTSEnumerateSessionsEx 関数は、ホスト自体で実行されているすべてのセッションと、個々の仮想マシンで実行されているセッションを集約します。ExecEnvId パラメーターは、集約された一覧の中で各セッションを一意に識別します。この識別子は、そのセッションをホストするサーバーまたは仮想マシンで定義されている実際のセッション識別子 (SessionId メンバーで指定されます) とは異なる場合があります。

この構造体が表すセッションは、サーバー上で直接実行されているセッションの場合も、仮想マシン内で実行されているセッションの場合もあります。セッションが仮想マシン内で実行されている場合、pHostName メンバーには仮想マシンの名前が格納されます。pFarmName メンバーは、RD セッション ホスト ファームに参加している仮想マシン上でホストされるセッションに適用されます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// WTS_SESSION_INFO_1W  (x64 56 / x86 32 バイト)
typedef struct WTS_SESSION_INFO_1W {
    DWORD ExecEnvId;
    WTS_CONNECTSTATE_CLASS State;
    DWORD SessionId;
    LPWSTR pSessionName;
    LPWSTR pHostName;
    LPWSTR pUserName;
    LPWSTR pDomainName;
    LPWSTR pFarmName;
} WTS_SESSION_INFO_1W;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WTS_SESSION_INFO_1W
{
    public uint ExecEnvId;
    public int State;
    public uint SessionId;
    public IntPtr pSessionName;
    public IntPtr pHostName;
    public IntPtr pUserName;
    public IntPtr pDomainName;
    public IntPtr pFarmName;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WTS_SESSION_INFO_1W
    Public ExecEnvId As UInteger
    Public State As Integer
    Public SessionId As UInteger
    Public pSessionName As IntPtr
    Public pHostName As IntPtr
    Public pUserName As IntPtr
    Public pDomainName As IntPtr
    Public pFarmName As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class WTS_SESSION_INFO_1W(ctypes.Structure):
    _fields_ = [
        ("ExecEnvId", wintypes.DWORD),
        ("State", ctypes.c_int),
        ("SessionId", wintypes.DWORD),
        ("pSessionName", ctypes.c_void_p),
        ("pHostName", ctypes.c_void_p),
        ("pUserName", ctypes.c_void_p),
        ("pDomainName", ctypes.c_void_p),
        ("pFarmName", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct WTS_SESSION_INFO_1W {
    pub ExecEnvId: u32,
    pub State: i32,
    pub SessionId: u32,
    pub pSessionName: *mut core::ffi::c_void,
    pub pHostName: *mut core::ffi::c_void,
    pub pUserName: *mut core::ffi::c_void,
    pub pDomainName: *mut core::ffi::c_void,
    pub pFarmName: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type WTS_SESSION_INFO_1W struct {
	ExecEnvId uint32
	State int32
	SessionId uint32
	pSessionName uintptr
	pHostName uintptr
	pUserName uintptr
	pDomainName uintptr
	pFarmName uintptr
}
type
  WTS_SESSION_INFO_1W = record
    ExecEnvId: DWORD;
    State: Integer;
    SessionId: DWORD;
    pSessionName: Pointer;
    pHostName: Pointer;
    pUserName: Pointer;
    pDomainName: Pointer;
    pFarmName: Pointer;
  end;
const WTS_SESSION_INFO_1W = extern struct {
    ExecEnvId: u32,
    State: i32,
    SessionId: u32,
    pSessionName: ?*anyopaque,
    pHostName: ?*anyopaque,
    pUserName: ?*anyopaque,
    pDomainName: ?*anyopaque,
    pFarmName: ?*anyopaque,
};
type
  WTS_SESSION_INFO_1W {.bycopy.} = object
    ExecEnvId: uint32
    State: int32
    SessionId: uint32
    pSessionName: pointer
    pHostName: pointer
    pUserName: pointer
    pDomainName: pointer
    pFarmName: pointer
struct WTS_SESSION_INFO_1W
{
    uint ExecEnvId;
    int State;
    uint SessionId;
    void* pSessionName;
    void* pHostName;
    void* pUserName;
    void* pDomainName;
    void* pFarmName;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WTS_SESSION_INFO_1W サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; ExecEnvId : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; State : WTS_CONNECTSTATE_CLASS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; SessionId : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; pSessionName : LPWSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pHostName : LPWSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; pUserName : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pDomainName : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; pFarmName : LPWSTR (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WTS_SESSION_INFO_1W サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; ExecEnvId : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; State : WTS_CONNECTSTATE_CLASS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; SessionId : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; pSessionName : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; pHostName : LPWSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; pUserName : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; pDomainName : LPWSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; pFarmName : LPWSTR (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WTS_SESSION_INFO_1W
    #field int ExecEnvId
    #field int State
    #field int SessionId
    #field intptr pSessionName
    #field intptr pHostName
    #field intptr pUserName
    #field intptr pDomainName
    #field intptr pFarmName
#endstruct

stdim st, WTS_SESSION_INFO_1W        ; NSTRUCT 変数を確保
st->ExecEnvId = 100
mes "ExecEnvId=" + st->ExecEnvId