Compartilhar via

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

  • Artigo

Pode ser usado por plug-ins para armazenar informações de contexto específicas para a conexão.

Sintaxe

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

Parâmetros

[in] contextId

Uma variável BSTR que contém a ID de contexto. É recomendável usar identificadores exclusivos como IDs de contexto para evitar colisões entre plug-ins. Um objeto de conexão de cliente pode ser usado por mais de um plug-in.

[in] context

As informações de contexto a serem armazenadas.

[out, optional] existingContext

As informações de contexto existentes para a ID de contexto fornecida, se houver, são retornadas nesse parâmetro. As informações existentes são substituídas.

Retornar valor

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Os plug-ins podem usar o objeto de conexão do cliente para armazenar informações de contexto específicas de uma solicitação de conexão. Isso permite que os plug-ins permaneçam sem estado e dependam exclusivamente das informações de estado armazenadas por solicitações de conexão. Plug-ins que usam esse método também podem se registrar para notificações de solicitação de conexão. Os contextos podem ser excluídos após o recebimento de notificações de CONNECTION_REQUEST_FAILED, CONNECTION_REQUEST_TIMEDOUT ou CONNECTION_REQUEST_SUCCEEDED. Essas notificações indicam que a solicitação de conexão está prestes a ser excluída.

Requisitos

Requisito Valor
Cliente mínimo com suporte Nenhum compatível
Servidor mínimo com suporte Windows Server 2012
Plataforma de Destino Windows
Cabeçalho sbtsv.h

Confira também

ITsSbClientConnection