iWTSSBPlugin：：WTSSBX_GetMostSuitableServer 方法 (tssbx.h)
[Windows Server 2008 R2 之後不支援 IWTSSBPlugin 介面。 從 Windows Server 2012 開始，請使用 ITsSbPlugin 介面。]
傳回終端機服務會話訊息代理程式 (TS 工作階段訊息代理程式) 應導向連入連線的伺服器識別碼。 外掛程式的重新導向邏輯會決定慣用的伺服器。
語法
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 會話代理人將重新導向連入連線之伺服器的標識碼指標。 此值一開始會設定為 TS 會話訊息代理程式負載平衡邏輯所提供的伺服器識別碼。
傳回值
如果成功 ， 則傳回S_OK。
備註
使用 WTSSBX_GetMostSuitableServer 覆寫 TS 會話訊息代理程式的預設負載平衡邏輯。 TS 會話訊息代理程式會在執行自己的負載平衡邏輯之後呼叫此方法。 pMachineId 參數一開始會設定為 TS 工作階段訊息代理程式的負載平衡邏輯所提供的伺服器識別碼。 當您實作這個方法時，重新導向邏輯可以視需要傳回這個 pMachineId 或另一個。
每當伺服器加入 TS 會話代理人中的伺服器數位列時，TS 會話訊息代理程式會呼叫 WTSSBX_MachineChangeNotification 方法來通知外掛程式，並提供 MachineId 來識別新的伺服器。 當 TS 工作話訊息代理程式 呼叫WTSSBX_GetMostSuitableServer時，外掛程式應該會傳回 TS 會話訊息代理程式提供給外掛程式的其中一個識別碼。 外掛程式不應該傳回不在伺服器數位中的伺服器識別碼。
如果成功，您的 WTSSBX_GetMostSuitableServer 實作必須立即傳回 S_OK 。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | Windows Vista |
| 最低支援的伺服器 | Windows Server 2008 |
| 目標平台 | Windows |
| 標頭 | tssbx.h |