iWTSSBPlugin：：WTSSBX_GetMostSuitableServer 方法 (tssbx.h)

[Windows Server 2008 R2 之后不支持 IWTSSBPlugin 接口。 从 Windows Server 2012请使用 ITsSbPlugin 接口。]

返回终端服务会话代理 (TS 会话代理) 应将传入连接定向到的服务器 ID。 插件的重定向逻辑确定首选服务器。

语法

HRESULT WTSSBX_GetMostSuitableServer(
  [in]      WCHAR *UserName,
  [in]      WCHAR *DomainName,
  [in]      WCHAR *ApplicationType,
  [in]      WCHAR *FarmName,
  [in, out] long  *pMachineId
);

参数

[in] UserName

指向包含传入连接的用户名的 Unicode 字符串的指针。

[in] DomainName

指向 Unicode 字符串的指针，该字符串包含与传入连接关联的域名。

[in] ApplicationType

指向 Unicode 字符串的指针，该字符串包含远程桌面服务创建会话后运行的程序的名称。

[in] FarmName

指向 Unicode 字符串的指针，该字符串包含用户连接到的 TS 会话代理中场的名称。

[in, out] pMachineId

指向 TS 会话代理将传入连接重定向到的服务器 ID 的指针。 此值最初设置为 TS 会话代理的负载均衡逻辑提供的服务器的 ID。

返回值

如果成功 ， 则返回S_OK。

注解

使用 WTSSBX_GetMostSuitableServer 替代 TS 会话代理的默认负载均衡逻辑。 TS 会话代理在运行自己的负载均衡逻辑后调用此方法。 pMachineId 参数最初设置为 TS 会话代理的负载均衡逻辑提供的服务器的 ID。 实现此方法时，重定向逻辑可以根据需要返回此 pMachineId 或另一个 pMachineId 。

每当服务器加入 TS 会话代理中的场时，TS 会话代理会调用 WTSSBX_MachineChangeNotification 方法来通知插件并提供 MachineId 来标识新服务器。 当 TS 会话代理调用 WTSSBX_GetMostSuitableServer时，插件应返回 TS 会话代理提供给插件的 ID 之一。 插件不应返回场外服务器的 ID。

如果成功， WTSSBX_GetMostSuitableServer 的实现必须立即返回 S_OK 。

要求

要求	值
最低受支持的客户端	Windows Vista
最低受支持的服务器	Windows Server 2008
目标平台	Windows
标头	tssbx.h

另请参阅

ITsSbPlugin

IWTSSBPlugin