IWTSSBPlugin::WTSSBX_GetMostSuitableServer メソッド (tssbx.h)
[ IWTSSBPlugin インターフェイスは、Windows Server 2008 R2 以降はサポートされていません。 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
ユーザーが接続している TS セッション ブローカーのファームの名前を含む Unicode 文字列へのポインター。
[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 |