TJwWTSSession Class

Pascal

TJwWTSSession = class(TObjectList);

File

JwsclTerminalServer

Description

TJwWTSSession is a Class that encapsulates a Terminal Server session and it's properties

A session is uniquely identified with a SessionID, this is a number between 0 and 65535.

A TJwWTSSession is owned by a JTwWTSSessionList.

Group

Classes

Public Methods

	Name	Description
	Create	This is the overview for the Create constructor overload.
	Destroy	The Destroy destructor disposes the Session object.

Topics

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

TJwWTSSession Methods

	Name	Description
	Connect	The Connect function allows you to connect to another Terminal Server session.
	Disconnect	The Disconnect function disconnects the logged-on user from the specified Terminal Services session without closing the session. The session remains attached to the terminal server in the disconnected state and currently running applications continue to run. When you attempt to reconnect to the same server , you are reconnected to the same session from which you disconnected, even if you are reconnecting from a different computer. Applications that were left open when you disconnected remain running when you reconnect to the session, with no loss of data. In NLB (Network Load Balancing) environments the Session Directory (starting from Server 2008... more
	GetClientAddress
	GetServerHandle
	Logoff	The Logoff function logs off a specified Terminal Services session
	PostMessage	The PostMessage function displays a message box on the client desktop.
	ProtocolTypeToStr
	SendLocalMessage	This is SendLocalMessage, a member of class TJwWTSSession.
	SendMessage	The SendMessage function displays a message box on the client desktop.
	Shadow	The Shadow function starts the remote control of another Terminal Services session. You must call this function from a remote session.

TJwWTSSession Properties

	Name	Description
	ApplicationName	ApplicationName returns the the startup application as specified in the Terminal Server client. If no startup application was specified an empty string is returned.
	ClientAddress	ClientAddress returns the Client IP Address as string. This is the local IP address of a client as reported by the Terminal Server Client
	ClientBuildNumber	ClientBuildNumber returns the version number of the Terminal Server Client
	ClientDirectory	ClientDirectory returns the version number of the Terminal Server Client
	ClientHardwareId	ClientHardwareId returns a client-specific hardware identifier
	ClientName	ClientName returns the local computer name of the client
	ClientProductId	ClientProductId returns a client-specific product identifier.
	ClientProtocolStr	ClientProtocolStr returns a string that indicates the protocol type This is one of the following values:
	ClientProtocolType	ClientProtocolType returns a value that indicates the protocol type This is one of the following values:
	ColorDepth	ColorDepth returns the number of colors used in the terminal session.
	CompressionRatio	CompressionRatio returns the current compression ratio as string with 2 decimals. Compression Ratio equals OutgoingCompressBytes / OutgoingBytescompressed Console sessions always returns empty value.
	ConnectState	ConnectState returns the connection state of the session. Which can be one of the following values:
	ConnectStateStr	ConnectStateStr returns a localised connection state string.
	ConnectTime	ConnectTime The most recent client connection time.
	CurrentTime	CurrentTime the time that the TJwWTSSession info was queried. This can be used to calculate time differences such as idle time
	CurrentTimeEx	This is CurrentTimeEx, a member of class TJwWTSSession.
	Data	Data allows storage of a pointer to user specific data and can be freely used.
	DisconnectTime	DisconnectTime the last client disconnection time.
	Domain	Domain the domain of the logged-on user
	HorizontalResolution	HorizontalResolution returns the width resolution of the terminal session display in pixels.
	IdleTime	IdleTime the elapsed time (relative to CurrentTime) since last user input in the session expressed in the number of 100-nanosecond intervals since January 1, 1601 (TFileTime).
	IdleTimeStr	IdleTimeStr the elapsed time (relative to CurrentTime) since last user input in the session as formatted string. The string is formatted according to the table below:
	IncomingBytes	IncomingBytes uncompressed Remote Desktop Protocol (RDP) data from the client to the server.
	InitialProgram	InitialProgram string containing the name of the initial program that Terminal Services runs when the user logs on.
	LastInputTime	LastInputTime the time of the last user input in the session.
	LogonTime	LogonTime the time that the user logged on to the session in the number of 100-nanosecond intervals since January 1, 1601 (TFileTime).
	LogonTimeStr	LogonTimeStr the time that the user logged on to the session as a localised Date Time string.
	OutgoingBytes	OutgoingBytes uncompressed RDP data from the server to the client.
	Owner	Owner of this session object, which can only be a TJwWTSSessionList
	RemoteAddress	RemoteAddress returns the real IP Address that is connected to the Terminal Server.
	RemotePort	RemotePort returns the Remote Port number which is is connected to the Terminal Server. The Terminal Server listens (by default) on port 3389 but the client connects with a random available port. RemotePort is the same port number you will see when you examine netstat output
	Server	Server the netbios name of the Terminal Server.
	SessionId	SessionId the session identifier There are some reserved SessionId's that serve a special purpose. The following table lists the reserved SessionId's:
	ShadowInformation	ShadowInformation returns information about the Shadow State and Shadow Mode of a session. Shadow State shows if the session is shadowing another session or is being shadowed by another session. Shadow Mode queries the shadow permissions for this session.
	Token	Token returns the token of the session. This call needs the TCB privilege and the process must run under SYSTEM account; otherwise EJwsclPrivilegeCheckException, EJwsclWinCallFailedException is raised. The returned value is cached and must not be freed!
	Username	Username the name of the user associated with the session.
	UserSid	UserSid returns the logged on User of the session. This call needs the TCB privilege and the process must run under SYSTEM account; otherwise EJwsclPrivilegeCheckException, EJwsclWinCallFailedException is raised. The returned token is the user's primary access token which can be passed directly to CreateProcessAsUser in order to launch a process in the user's Session.
	VerticalResolution	VerticalResolution returns the height resolution of the terminal session display in pixels.
	WdFlag	WinStationDriver Flag (WdFlag) returns a value indicating the protocol and connection type. It's usefull for easy determination of console session. Possible values:
	WinStationDriverName	WinStationDriver Name (WinStationDriverName) returns a value indicating the protocol and protocol type. Known Microsoft values:
	WinStationName	WinStationName returns the session name.
	WorkingDirectory	WorkingDirectory the default directory used when launching the initial program.

Links

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

Contents | Index | Home

What do you think about this topic? Send feedback!