ITsSbClientConnection interface

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.

Members

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

Methods

The ITsSbClientConnection interface has these methods.

MethodDescription
GetContext

Retrieves context information that was stored by a plug-in by using the PutContext method.

GetDisconnectedSession

Gets a disconnected session.

PutContext

Can be used by plug-ins to store context information specific to the connection.

 

Properties

The ITsSbClientConnection interface has these properties.

PropertyAccess typeDescription

ClientConnectionPropertySet

Read-only

The property set object for this connection.

ConnectionError

Read-only

The error that occurred while a client connection was being processed.

Domain

Read-only

The domain name of the Remote Desktop Connection (RDC) client.

Environment

Read-only

The environment that hosts the target computer.

InitialProgram

Read-only

The program that is launched when the user logs on to the target computer.

LoadBalanceResult

Read-only

The name of the target computer returned by load balancing.

SamUserAccount

Read-only

The domain name and user name of the user who initiated the connection.

UserName

Read-only

The name of the user who initiated the connection.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

IDL

Sbtsv.idl

See also

Remote Desktop Virtualization Interfaces

 

 

Show: