ITsSbClientConnection：:P utContext 方法 (sbtsv.h)

  • 项目

插件可用于存储特定于连接的上下文信息。

语法

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

参数

[in] contextId

包含上下文 ID 的 BSTR 变量。 建议使用唯一标识符作为上下文 ID，以避免插件之间的冲突。客户端连接对象可由多个插件使用。

[in] context

要存储的上下文信息。

[out, optional] existingContext

此参数中返回所提供的上下文 ID 的现有上下文信息（如果有）。 覆盖现有信息。

返回值

如果该方法成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

插件可以使用客户端连接对象来存储特定于连接请求的上下文信息。 这允许插件保持无状态，并完全依赖于连接请求存储的状态信息。 使用此方法的插件还可以注册连接请求通知。 可以在收到CONNECTION_REQUEST_FAILED、CONNECTION_REQUEST_TIMEDOUT或CONNECTION_REQUEST_SUCCEEDED通知后删除上下文。 这些通知指示连接请求即将被删除。

要求

要求 值
最低受支持的客户端 无受支持的版本
最低受支持的服务器 Windows Server 2012
目标平台 Windows
标头 sbtsv.h

另请参阅

ITsSbClientConnection