Método IConnectionPoint::Advise (ocidl.h)

  • Artigo

Estabelece uma conexão entre um objeto de ponto de conexão e o coletor do cliente.

Sintaxe

HRESULT Advise(
  [in]  IUnknown *pUnkSink,
  [out] DWORD    *pdwCookie
);

Parâmetros

[in] pUnkSink

Um ponteiro para a interface IUnknown no coletor de aconselhamento do cliente. O coletor do cliente recebe chamadas de saída do ponto de conexão.

[out] pdwCookie

Um ponteiro para um token retornado que identifica exclusivamente essa conexão. O chamador usa esse token posteriormente para excluir a conexão passando-a para o método IConnectionPoint::Unadvise . Se a conexão não tiver sido estabelecida com êxito, esse valor será zero.

Retornar valor

Esse método pode retornar os valores de retorno padrão E_OUTOFMEMORY e E_UNEXPECTED, bem como os valores a seguir.

Código de retorno Descrição
S_OK
 A conexão foi estabelecida e *pdwCookie tem o token de conexão.
E_POINTER
 O valor em pUnkSink ou pdwCookie não é válido. Por exemplo, qualquer ponteiro pode ser NULL.
CONNECT_E_ADVISELIMIT
 O ponto de conexão já atingiu seu limite de conexões e não pode aceitar mais nenhuma.
CONNECT_E_CANNOTCONNECT
 O coletor não dá suporte à interface exigida por esse ponto de conexão.

Comentários

O aviso estabelece uma conexão entre o ponto de conexão e o coletor do chamador identificado com pUnkSink.

O ponto de conexão deve chamar QueryInterface para obter o ponteiro de interface de saída correto para chamar quando os eventos ocorrem, com o IID para a interface de saída gerenciada pelo ponto de conexão. Quando o IID é passado para o método IConnectionPointContainer::FindConnectionPoint , um ponteiro de interface para esse mesmo ponto de conexão é retornado.

Anotações aos implementadores

O ponto de conexão deve consultar o ponteiro pUnkSink para a interface de saída correta. Se essa consulta falhar, esse método deverá retornar CONNECT_E_CANNOTCONNECT.

O valor pdwCookie deve ser exclusivo para cada conexão com qualquer instância específica de um ponto de conexão.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho ocidl.h

Confira também

IConnectionPoint