Método IOleObject::EnumAdvise (oleidl.h)

Recupera um ponteiro para um enumerador que pode ser usado para enumerar as conexões de consultoria registradas para um objeto, para que um contêiner possa saber o que liberar antes de fechar.

Sintaxe

HRESULT EnumAdvise(
  [out] IEnumSTATDATA **ppenumAdvise
);

Parâmetros

[out] ppenumAdvise

Endereço da variável de ponteiro IEnumSTATDATA que recebe o ponteiro de interface para o objeto enumerador. Se o objeto não tiver nenhuma conexão de consultoria ou se ocorrer um erro, a implementação deverá definir ppenumAdvise como NULL. Cada vez que um objeto recebe uma chamada bem-sucedida para IOleObject::EnumAdvise, ele deve aumentar a contagem de referência em ppenumAdvise. É responsabilidade do chamador chamar Release quando terminar com o ppenumAdvise.

Retornar valor

Esse método retorna S_OK em caso de êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno	Descrição
E_NOTIMPL	IOleObject::EnumAdvise não está implementado.

Comentários

O método IOleObject::EnumAdvise fornece um enumerador que fornece uma maneira de os contêineres controlarem as conexões de consultoria registradas para seus objetos. Um contêiner normalmente chamaria essa função para que ele possa instruir um objeto a liberar cada uma de suas conexões de consultoria antes de fechar.

O enumerador ao qual você obtém acesso por meio de IOleObject::EnumAdvise enumera itens do tipo STATDATA. Ao receber o ponteiro, o contêiner pode executar um loop por STATDATA e chamar IOleObject::Unadvise para cada conexão enumerada.

A maneira usual de implementar essa função é delegar a chamada para a interface IOleAdviseHolder . Somente os membros pAdvise e dwConnection de STATDATA são relevantes para IOleObject::EnumAdvise.

Requisitos

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

Confira também

Ioleobject

IOleObject::Advise

IOleObject::Unadvise