Compartilhar via


Método ITextStoreAnchor::AdviseSink (textstor.h)

O método ITextStoreAnchor::AdviseSink instala um novo coletor de consultoria da interface ITextStoreAnchorSink ou modifica um coletor de consultoria existente.

Sintaxe

HRESULT AdviseSink(
  [in] REFIID   riid,
  [in] IUnknown *punk,
  [in] DWORD    dwMask
);

Parâmetros

[in] riid

Especifica a interface do coletor. O único valor com suporte é IID_ITextStoreAnchorSink.

[in] punk

Ponteiro para a interface do coletor a ser aconselhada. Não pode ser NULL.

[in] dwMask

Especifica os eventos que notificam o coletor de avisos. Para obter mais informações sobre possíveis valores de parâmetro, consulte Constantes TS_AS_*.

Retornar valor

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
O método foi bem-sucedido.
E_FAIL
Não foi possível obter o riid da interface do coletor especificado.
E_INVALIDARG
A interface do coletor especificada não tem suporte.
E_UNEXPECTED
Não foi possível obter o objeto de coletor especificado.

Comentários

Chamadas subsequentes com a mesma interface, representadas pelo parâmetro punk , são tratadas como solicitações para atualizar o parâmetro dwMask . Os servidores não devem chamar o método AddRef no coletor em resposta a essa solicitação.

Os servidores mantêm apenas um único ponto de conexão. Tenta aconselhar que um segundo objeto coletor falhe até que o objeto de coletor original seja removido. Os aplicativos devem usar o método ITextStoreAnchor::UnadviseSink para cancelar o registro do objeto de coletor quando as notificações não forem necessárias.

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 textstor.h
DLL Msctf.dll
Redistribuível TSF 1.0 no Windows 2000 Professional

Confira também

ITextStoreAnchor

ITextStoreAnchor::UnadviseSink

Constantes TS_AS_*