TJwTerminalServer Class

Pascal

TJwTerminalServer = class(TObject);

File

JwsclTerminalServer

Description

AbstractTJwTerminalServer is the central object of JwsclTerminalServer and holds the session- and processlist.

TJwTerminalServer offers connection to a Terminal Server which you can specify with the Server property. Key functions of TJwTerminalServer are:

EnumerateSessions enumerates all Terminal Server sessions into a

TJwSessionList which can be accessed by the Sessions property.

EnumerateProcesses enumerates all Terminal Server processes into a

TJwProcessList which can be accessed by the Processes property.

EnumerateServers enumerates all Terminal Servers in a domain.
Shutdown Shuts down and optionally restarts the specified

Terminal Server.

TJwTerminalServer also offers Events to monitor Terminal Server activity such as OnSessionConnect, OnSessionCreate, OnSessionLogon and OnSessionLogoff.

The schema below shows the relations between TJwTerminalServer, the TJwWTSSessionList with TJwWTSSessions and the TJwWTSProcessList with TjwWTSSessions.

Group

Classes

Public Methods

	Name	Description
	Create	This is the overview for the Create constructor overload.
	Destroy

Topics

Name	Description
TJwTerminalServer Members	The following tables list the members exposed by TJwTerminalServer.
TJwTerminalServer Methods	The methods of the TJwTerminalServer class are listed here.
TJwTerminalServer Properties	The properties of the TJwTerminalServer class are listed here.

TJwTerminalServer Methods

	Name	Description
	Connect	Connect sets up the connection with the Terminal Server specified in the Server property. The Connected property can be used to check if we're already connected.
	Disconnect	Disconnect will disconnect an existing connection to the Terminal Server. The Connected property can be used to check if we're already connected.
	EnumerateProcesses	This is the overview for the EnumerateProcesses method overload.
	EnumerateProcessesEx	This is the overview for the EnumerateProcessesEx method overload.
	EnumerateServers	EnumerateServers enumerates all Terminal Servers in the specified domain. The result will be stored in readonly property Servers.
	EnumerateSessions	EnumerateSessions enumerates all sessions on the Terminal Server and fills the Sessions property with a TJwSessionList. This list contains all sessions and their properties such as Username, Session Id, Connection State, Idle Time and so on.
	FileTime2DateTime	FileTime2DateTime can be used to convert a non local (GMT time) FileTime to a localised TDateTime var.
	IsValidServerHandle	This is IsValidServerHandle, a member of class TJwTerminalServer.
	Session	This is Session, a member of class TJwTerminalServer.
	Shutdown	Shutdown shuts down (and optionally restarts) the specified terminal server.

TJwTerminalServer Properties

	Name	Description
	ComputerName	ComputerName returns the local computername. This property is convenient if you are connecting to Terminal Server locally or want to check if a servername = computername.
	Connected	Connected indicates if we are connected to the Terminal Server
	Data	Data allows storage of a pointer to user specific data and can be freely used.
	IdleProcessName
	LastEventFlag	The LastEventFlag property can be used to see the Last Session Event that occured. This is usefull if you are listening on multiple event types.
	OnLicenseStateChange	The OnLicenseStateChange event is fired when when a license is added or deleted using License Manager.
	OnServersEnumerated	The OnServersEnumerated event signals that the Server Enumeration thread has finished. The Enumerated Servers can be read through the Servers property.
	OnSessionConnect	The OnSessionConnect event is fired when a client connects to a session
	OnSessionCreate	The OnSessionCreate event is fired when a session is created
	OnSessionDelete	The OnSessionDelete event is fired when a session is deleted
	OnSessionDisconnect	The OnSessionDisconnect event is fired when a session is disconnected
	OnSessionEvent	The OnSessionEvent is a generic event which is fired if anything happens that is session related, like statechange, logon/logoff, disconnect and (re)connect. The table below shows which Terminal Server event triggers which event:
	OnSessionLogoff	The OnSessionLogoff event is fired when a client logs off either from the console or a session
	OnSessionLogon	The OnSessionLogon event is fired when a client logs on either through the console or a session
	OnSessionStateChange	The OnSessionStateChange event is fired when the connectstate of a session has changed
	OnWinStationRename	The OnWinStationRename event is fired when an existing session has been renamed
	PhysicalMemory	This is PhysicalMemory, a member of class TJwTerminalServer.
	Processes	Processes contains a TJwWTSProcessList of which each item contains a TJwWTSProcess. This processlist contains all enumerated processes and their properties such as Process Name, Process Id, Username, Memory Usage and so on.
	Processors	This is Processors, a member of class TJwTerminalServer.
	Server	Server the netbios name of the Terminal Server.
	ServerHandle
	Servers	Servers contains the list of Enumerated Terminal Servers. May be nil!
	Sessions	Sessions contains a TJwWTSSessionList of which each item contains a TJwWTSSession. This sessionlist contains all enumerated sessions and their properties such as Username, Connection State, Idle Time and so on.
	Statistics	This is Statistics, a member of class TJwTerminalServer.
	SystemUserName	SystemUserName returns the (localised) name of the system user
	Tag	Tag has no predefined meaning. The Tag property is provided for the convenience of developers. It can be used for storing an additional integer value or it can be typecast to any 32-bit value such as a component reference or a pointer.

Links

Create Constructor, TJwTerminalServer Methods, TJwTerminalServer Properties, TJwTerminalServer Members, JwsclTerminalServer, Classes, Legend, Members, Public Methods, Topics, TJwTerminalServer Methods, TJwTerminalServer Properties

Contents | Index | Home

What do you think about this topic? Send feedback!