Méthode IWTSSBPlugin ::WTSSBX_GetMostSuitableServer (tssbx.h)

[ L’interface IWTSSBPlugin n’est pas prise en charge après Windows Server 2008 R2. À partir de Windows Server 2012 utilisez l’interface ITsSbPlugin.]

Retourne l’ID du serveur vers lequel le Répartiteur de sessions Terminal Services (TS Session Broker) doit diriger la connexion entrante. La logique de redirection du plug-in détermine le serveur préféré.

Syntaxe

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

Paramètres

[in] UserName

Pointeur vers une chaîne Unicode qui contient le nom d’utilisateur de la connexion entrante.

[in] DomainName

Pointeur vers une chaîne Unicode qui contient le nom de domaine associé à la connexion entrante.

[in] ApplicationType

Pointeur vers une chaîne Unicode qui contient le nom du programme exécuté par les services Bureau à distance après avoir créé la session.

[in] FarmName

Pointeur vers une chaîne Unicode qui contient le nom de la batterie de serveurs dans TS Session Broker à laquelle l’utilisateur se connecte.

[in, out] pMachineId

Pointeur vers l’ID du serveur vers lequel TS Session Broker redirigera la connexion entrante. Cette valeur est initialement définie sur l’ID du serveur fourni par la logique d’équilibrage de charge de TS Session Broker.

Valeur retournée

Retourne S_OK en cas de réussite.

Remarques

Utilisez WTSSBX_GetMostSuitableServer pour remplacer la logique d’équilibrage de charge par défaut de TS Session Broker. TS Session Broker appelle cette méthode après avoir exécuté sa propre logique d’équilibrage de charge. Le paramètre pMachineId est initialement défini sur l’ID du serveur fourni par la logique d’équilibrage de charge de TS Session Broker. Lorsque vous implémentez cette méthode, votre logique de redirection peut retourner ce pMachineId ou un autre, selon le cas.

Chaque fois qu’un serveur rejoint une batterie de serveurs dans TS Session Broker, TS Session Broker appelle la méthode WTSSBX_MachineChangeNotification pour notifier le plug-in et fournir un MachineId pour identifier le nouveau serveur. Lorsque TS Session Broker appelle WTSSBX_GetMostSuitableServer, le plug-in doit retourner l’un des ID fournis par TS Session Broker au plug-in. Le plug-in ne doit pas retourner l’ID d’un serveur qui n’est pas dans la batterie de serveurs.

Votre implémentation de WTSSBX_GetMostSuitableServer doit retourner S_OK immédiatement si elle réussit.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista
Serveur minimal pris en charge Windows Server 2008
Plateforme cible Windows
En-tête tssbx.h

Voir aussi

ITsSbPlugin

IWTSSBPlugin