Location: Symbol Reference > Classes > TJwWTSSession Class > TJwWTSSession Members
JWSCL Documentation
ContentsIndexHome
TJwWTSSession Members Public Properties
Public Properties
 
Name 
Description 
 
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 returns the Client IP Address as string. This is the local IP address of a client as reported by the Terminal Server Client 
 
ClientBuildNumber returns the version number of the Terminal Server Client 
 
ClientDirectory returns the version number of the Terminal Server Client 
 
ClientHardwareId returns a client-specific hardware identifier 
 
ClientName returns the local computer name of the client 
 
ClientProductId returns a client-specific product identifier. 
 
ClientProtocolStr returns a string that indicates the protocol type This is one of the following values:  
 
ClientProtocolType returns a value that indicates the protocol type This is one of the following values:  
 
ColorDepth returns the number of colors used in the terminal session. 
 
CompressionRatio returns the current compression ratio as string with 2 decimals. Compression Ratio equals OutgoingCompressBytes / OutgoingBytescompressed Console sessions always returns empty value. 
 
ConnectState returns the connection state of the session. Which can be one of the following values:  
 
ConnectStateStr returns a localised connection state string. 
 
ConnectTime The most recent client connection time. 
 
CurrentTime the time that the TJwWTSSession info was queried. This can be used to calculate time differences such as idle time 
 
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 the last client disconnection time. 
 
Domain the domain of the logged-on user 
 
HorizontalResolution returns the width resolution of the terminal session display in pixels. 
 
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 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 uncompressed Remote Desktop Protocol (RDP) data from the client to the server. 
 
InitialProgram string containing the name of the initial program that Terminal Services runs when the user logs on. 
 
LastInputTime the time of the last user input in the session. 
 
LogonTime the time that the user logged on to the session in the number of 100-nanosecond intervals since January 1, 1601 (TFileTime).  
 
LogonTimeStr the time that the user logged on to the session as a localised Date Time string.  
 
OutgoingBytes uncompressed RDP data from the server to the client. 
 
Owner of this session object, which can only be a TJwWTSSessionList 
 
RemoteAddress returns the real IP Address that is connected to the Terminal Server
 
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 the netbios name of the Terminal Server. 
 
SessionId the session identifier
There are some reserved SessionId's that serve a special purpose. The following table lists the reserved SessionId's:
 
 
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 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 the name of the user associated with the session. 
 
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 returns the height resolution of the terminal session display in pixels. 
 
WinStationDriver Flag (WdFlag) returns a value indicating the protocol and connection type. It's usefull for easy determination of console session. Possible values:  
 
WinStationDriver Name (WinStationDriverName) returns a value indicating the protocol and protocol type. Known Microsoft values:  
 
WinStationName returns the session name. 
 
WorkingDirectory the default directory used when launching the initial program. 
Copyright (c) 2010. All rights reserved.
This help was created by Doc-O-Matic sponsored by toolsfactory software inc.