Метод ITsSbClientConnection::P utContext (sbtsv.h)

Статья
08/25/2023

Может использоваться подключаемыми модулями для хранения контекстных сведений, относящихся к подключению.

Синтаксис

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

Параметры

[in] contextId

Переменная BSTR , содержащая идентификатор контекста. Мы рекомендуем использовать уникальные идентификаторы в качестве идентификаторов контекста, чтобы избежать конфликтов между подключаемыми модулями. Объект подключения клиента может использоваться несколькими подключаемыми модулями.

[in] context

Сохраняемая контекстная информация.

[out, optional] existingContext

В этом параметре возвращаются существующие сведения о контексте для предоставленного идентификатора контекста, если таковой имеется. Существующие сведения перезаписываются.

Возвращаемое значение

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Подключаемые модули могут использовать объект подключения клиента для хранения контекстных сведений, относящихся к запросу на подключение. Это позволяет подключаемым модулям оставаться без отслеживания состояния и полагаться исключительно на сведения о состоянии, хранящиеся в запросах на подключение. Подключаемые модули, использующие этот метод, также могут регистрироваться для уведомлений о запросах на подключение. Контексты можно удалять при получении CONNECTION_REQUEST_FAILED, CONNECTION_REQUEST_TIMEDOUT или CONNECTION_REQUEST_SUCCEEDED уведомлений. Эти уведомления указывают на то, что запрос на подключение будет удален.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows Server 2012
Целевая платформа	Windows
Header	sbtsv.h

См. также раздел

ITsSbClientConnection

Поделиться через