ITsSbClientConnection::P utContext-Methode (sbtsv.h)

Kann von Plug-Ins verwendet werden, um kontextspezifische Informationen für die Verbindung zu speichern.

Syntax

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

Parameter

[in] contextId

Eine BSTR-Variable , die die Kontext-ID enthält. Es wird empfohlen, eindeutige Bezeichner als Kontext-IDs zu verwenden, um Konflikte zwischen Plug-Ins zu vermeiden. Ein Clientverbindungsobjekt kann von mehreren Plug-Ins verwendet werden.

[in] context

Die zu speichernden Kontextinformationen.

[out, optional] existingContext

In diesem Parameter werden ggf. vorhandene Kontextinformationen für die angegebene Kontext-ID zurückgegeben. Die vorhandenen Informationen werden überschrieben.

Rückgabewert

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Plug-Ins können das Clientverbindungsobjekt verwenden, um Kontextinformationen zu speichern, die für eine Verbindungsanforderung spezifisch sind. Dadurch bleiben Plug-Ins zustandslos und verlassen sich ausschließlich auf Zustandsinformationen, die von Verbindungsanforderungen gespeichert werden. Plug-Ins, die diese Methode verwenden, können sich auch für Verbindungsanforderungsbenachrichtigungen registrieren. Kontexte können nach Erhalt von CONNECTION_REQUEST_FAILED, CONNECTION_REQUEST_TIMEDOUT oder CONNECTION_REQUEST_SUCCEEDED Benachrichtigungen gelöscht werden. Diese Benachrichtigungen weisen darauf hin, dass die Verbindungsanforderung gelöscht wird.

Anforderungen

Weitere Informationen

ITsSbClientConnection