ITsSbClientConnection interface (sbtsv.h)

Exposes methods and properties that store state information about an incoming connection request from a Remote Desktop Connection (RDC) client. This information does not need to be stored on the resource or filter plug-ins, which allows the plug-ins to be stateless.

Plug-ins can use this interface to obtain information about a connection request initiated by a client, and then make decisions about load balancing, placement, and orchestration. This interface also stores the results of all these operations. A ITsSbClientConnection object should persist until the client successfully logs on to a target computer.

Inheritance

The ITsSbClientConnection interface inherits from the IUnknown interface. ITsSbClientConnection also has these types of members:

Methods

The ITsSbClientConnection interface has these methods.

ITsSbClientConnection::get_ClientConnectionPropertySet Retrieves an object that contains properties associated with the client connection.
ITsSbClientConnection::get_ConnectionError Retrieves a value that indicates the error that occurred while a client connection was being processed.
ITsSbClientConnection::get_Domain Retrieves a value that indicates the domain name of the Remote Desktop Connection (RDC) client.
ITsSbClientConnection::get_Environment Retrieves an object that contains information about the environment that hosts the target computer.
ITsSbClientConnection::get_FarmName Farm name.
ITsSbClientConnection::get_InitialProgram Retrieves a value that indicates the program that is launched when the user logs on to the target computer.
ITsSbClientConnection::get_IsFirstAssignment Whether this is the first assignment.
ITsSbClientConnection::get_LoadBalanceResult Retrieves a value that indicates the name of the target computer returned by load balancing.
ITsSbClientConnection::get_RdFarmType Rd Farm Type.
ITsSbClientConnection::get_SamUserAccount Retrieves a value that indicates the domain name and user name of the user who initiated the connection.
ITsSbClientConnection::get_UserName Retrieves a value that indicates the name of the user who initiated the connection.
ITsSbClientConnection::get_UserSidString User SID as a string.
ITsSbClientConnection::GetContext Retrieves context information that was stored by a plug-in by using the PutContext method.
ITsSbClientConnection::GetDisconnectedSession Gets a disconnected session.
ITsSbClientConnection::PutContext Can be used by plug-ins to store context information specific to the connection.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	sbtsv.h

See also

Remote Desktop Virtualization Interfaces