Méthode ITsSbClientConnection ::P utContext (sbtsv.h)

Article
03/04/2024

Peut être utilisé par les plug-ins pour stocker des informations de contexte spécifiques à la connexion.

Syntaxe

HRESULT PutContext(
  [in]            BSTR    contextId,
  [in]            VARIANT context,
  [out, optional] VARIANT *existingContext
);

Paramètres

[in] contextId

Variable BSTR qui contient l’ID de contexte. Nous vous recommandons d’utiliser des identificateurs uniques comme ID de contexte pour éviter les collisions entre les plug-ins. Un objet de connexion client peut être utilisé par plusieurs plug-ins.

[in] context

Informations de contexte à stocker.

[out, optional] existingContext

Les informations de contexte existantes pour l’ID de contexte fourni, le cas échéant, sont retournées dans ce paramètre. Les informations existantes sont remplacées.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Les plug-ins peuvent utiliser l’objet de connexion client pour stocker des informations de contexte spécifiques à une demande de connexion. Cela permet aux plug-ins de rester sans état et de s’appuyer exclusivement sur les informations d’état stockées par les demandes de connexion. Les plug-ins qui utilisent cette méthode peuvent également s’inscrire aux notifications de demande de connexion. Les contextes peuvent être supprimés à la réception des notifications CONNECTION_REQUEST_FAILED, CONNECTION_REQUEST_TIMEDOUT ou CONNECTION_REQUEST_SUCCEEDED. Ces notifications indiquent que la demande de connexion est sur le point d’être supprimée.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2012
Plateforme cible	Windows
En-tête	sbtsv.h

Voir aussi

ITsSbClientConnection

Partager via