IWTSSBPlugin::WTSSBX_GetUserExternalSession method

[The IWTSSBPlugin interface is not supported after Windows Server 2008 R2. Starting with Windows Server 2012 please use the ITsSbPlugin interface.]

Redirects an incoming connection to a computing resource, such as a virtual machine, a blade server, or even the user's own corporate desktop by providing a WTSSBX_MACHINE_CONNECT_INFO structure that contains information about the resource.

Syntax


HRESULT WTSSBX_GetUserExternalSession(
  [in]  WCHAR                       *UserName,
  [in]  WCHAR                       *DomainName,
  [in]  WCHAR                       *ApplicationType,
  [in]  WTSSBX_IP_ADDRESS           *RedirectorInternalIP,
  [out] DWORD                       *pSessionID,
  [out] WTSSBX_MACHINE_CONNECT_INFO *pMachineConnectInfo
);

Parameters

UserName [in]

A pointer to a Unicode string that contains the user name of the incoming connection.

DomainName [in]

A pointer to a Unicode string that contains the domain name of the incoming connection.

ApplicationType [in]

A pointer to a Unicode string that contains the program that Remote Desktop Services runs after the user session is created.

RedirectorInternalIP [in]

A pointer to the internal IP address of the RD Session Host server that first accepted the connection.

pSessionID [out]

A pointer to the session ID of the session to which the plug-in is redirecting the incoming connection.

pMachineConnectInfo [out]

A pointer to a WTSSBX_MACHINE_CONNECT_INFO structure that contains information about the computer to which the plug-in is directing the incoming connection.

Return value

Returns S_OK if successful.

Remarks

Terminal Services Session Broker (TS Session Broker) calls this method so that the plug-in can redirect an incoming connection to a computer that is not joined to a farm in TS Session Broker.

Your implementation of WTSSBX_GetUserExternalSession should return E_NOTIMPL if it does not support redirection to computers that are not joined to farms in TS Session Broker.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

End of server support

Windows Server 2008 R2

Header

Tssbx.h

IDL

Tssbx.idl

IID

IID_IWTSSBPlugin is defined as DC44BE78-B18D-4399-B210-641BF67A002C

See also

IWTSSBPlugin
ITsSbPlugin

 

 

Show: