IWTSSBPlugin::WTSSBX_GetUserExternalSession method (tssbx.h)

[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

[in] UserName

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

[in] DomainName

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

[in] ApplicationType

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

[in] RedirectorInternalIP

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

[out] pSessionId

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

[out] pMachineConnectInfo

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

See also

ITsSbPlugin

IWTSSBPlugin