3.3.1.1 Abstract Data Types
TS_COUNTER: A Terminal Services performance counter structure used to represent a single performance counter. It is described in section 2.2.2.17. An array of these structures is returned by the RpcGetSessionCounters method.
dwCounterID: Identifier of a performance counter. It is used with RpcGetSessionCounters and MUST be set to one of the values described in section 2.2.2.17.1.
SessionHandle: Handle to a session. It is defined in section 2.2.1.1. The following list shows how SessionHandle is used with various methods.
RpcOpenSession as the phSession parameter.
RpcCloseSession as the phSession parameter.
RpcConnect as the hSession parameter.
RpcDisconnect as the hSession parameter.
RpcLogoff as the hSession parameter.
RpcGetUserName as the hSession parameter.
RpcGetTerminalName as the hSession parameter.
RpcGetState as the hSession parameter.
RpcIsSessionDesktopLocked as the hSession parameter.
RpcShowMessageBox as the hSession parameter.
RpcGetTimes as the hSession parameter.
ExecutionEnvironmentData: A structure containing information about the sessions running on the terminal server and the sessions running on virtual machines hosted on the server. It is used with RpcGetAllSessions and returned as the ppSessionData parameter.
SessionState: Current state of a session. It MUST be set to one of the values of the WINSTATIONSTATECLASS enumeration as defined in section 2.2.1.9. The following list shows how SessionState is used with various methods.
RpcGetState as the plState parameter.
RpcGetSessionInformationEx as the SessionState member of the LSM_SESSIONINFO_EX_LEVEL1 structure.
RpcWaitForSessionState as the State parameter.
RpcFilterByState as the State parameter.
RpcGetEnumResultEx as the State member of the SESSIONENUM_LEVEL1, SESSIONENUM_LEVEL2, and SESSIONENUM_LEVEL3 structures.
RpcGetAllSessions as the State member of the EXECENVDATA_LEVEL1 and EXECENVDATA_LEVEL2 structures.
hEnum: Handle to the session enumeration object. This is of type ENUM_HANDLE. It is used with TermSrvEnumeration methods.
hNotify: Handle to the notification object. It is of type NOTIFY_HANDLE. It is used with TermSrvNotification methods.
UserSessions: The number of sessions which are of SESSIONTYPE_REGULARDESKTOP, or SESSIONTYPE_ALTERNATESHELL, or SESSIONTYPE_REMOTEAPP as defined in SESSIONTYPE (section 2.2.1.18). It is used with the RpcGetLoggedOnCount method and is returned as the pUserSessions parameter.
DeviceSessions: The number of sessions connected using media center extender device only. These sessions are of SESSIONTYPE_MEDIACENTEREXT as defined in SESSIONTYPE (section 2.2.1.18). It is used with the RpcGetLoggedOnCount method and is returned as the pDeviceSessions parameter. For more information on media center, see [MSFT-WINMCE].
PSESSIONENUM: Pointer to a structure containing information about the sessions running on the terminal server. This structure is described in detail in section 2.2.2.4. It is used with the RpcGetEnumResult method and returned as the ppSessionEnumResult parameter.
SessionInfo: Union of structures, each structure providing different levels of detail about sessions running on a computer. This union is described in detail in section 2.2.2.4.1. It is used with the RpcGetEnumResult method and returned as the Data field of the ppSessionEnumResult parameter.
SessionInfo_Ex: Union of structures, each structure providing different levels of detail about sessions running on a computer. This union is described in detail in section 2.2.2.5.1. It is used with the RpcGetEnumResultEx method and returned as the Data field of the ppSessionEnumResult parameter.
PSESSIONENUM_EX: Pointer to a structure containing information about the sessions running on the terminal server. This structure is described in detail in section 2.2.2.5. It is used with the RpcGetEnumResultEx method and returned as the ppSessionEnumResult parameter.
SESSIONTYPE: Represents the type of the session as described in section 2.2.1.18. It is used with the RpcGetSessionType method and returned as the pSessionType parameter.
ConnectTime: Represents the most recent time of a connection to the session. It is used with the RpcGetTimes method and returned as the pConnectTime parameter.
DisconnectTime: Represents the most recent time of a disconnection from the session. It is used with the RpcGetTimes method and returned as the pDisconnectTime parameter.
LogonTime: Represents the most recent time of a logon to the session. It is used with the RpcGetTimes method and returned as the pLogonTime parameter.
PLSMSESSIONINFORMATION: Pointer to a structure containing information about a session running on the terminal server. This structure is described in detail in section 2.2.2.8. It is used with the RpcGetSessionInformation method and returned as the pSessionInfo parameter.
PLSMSESSIONINFORMATION_EX: Pointer to a structure containing information about a session running on the terminal server. This structure is described in detail in section 2.2.2.9. It is used with the RpcGetSessionInformationEx method and returned as the LSMSessionInfoExPtr parameter.
PEXECENVDATA: Pointer to a structure containing information about the sessions running on the terminal server and the sessions running on virtual machines hosted on the server. This structure is described in detail in section 2.2.2.6. It is returned by the RpcGetAllSessions method.
EXECENVDATA_LEVEL1: Structure that contains basic information about sessions running on a computer. This structure is described in detail in section 2.2.2.6.1.1. It is used with the RpcGetAllSessions method.
EXECENVDATA_LEVEL2: Structure that contains information about sessions running on a computer that is more detailed than the information contained in EXECENVDATA_LEVEL1. This structure is described in detail in section 2.2.2.6.1.2. It is used with the RpcGetAllSessions method.
SESSION_FILTER: Represents the type of filter to apply when retrieving the list of session IDs running on a terminal server. It is described in section 2.2.2.1. It is used with the RpcGetSessionIds method as the Filter parameter.
SESSION_CHANGE: Structure containing the ID of a session running on a terminal server and a mask of the notifications that were received for that session. This structure is described in detail in section 2.2.2.42. It is used with the RpcWaitAsyncNotification method.
PEXECENVDATAEX: Pointer to a structure containing information about the sessions running on the terminal server and the sessions running on virtual machines hosted on the server. This structure is described in detail in section 2.2.2.7. It is returned by the RpcGetAllSessionsEx method.
EXECENVDATAEX_LEVEL1: Structure that contains basic information about sessions running on a computer. This structure is described in detail in section 2.2.2.7.1.1. It is used with the RpcGetAllSessionsEx method.