Метод IOleAdviseHolder::EnumAdvise (oleidl.h)

Статья
03/01/2024

Создает перечислитель, который можно использовать для перечисления консультативных соединений, установленных в данный момент для объекта .

Синтаксис

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

Параметры

[out] ppenumAdvise

Указатель на переменную указателя IEnumSTATDATA , которая получает указатель интерфейса на новый перечислитель. Если этот параметр имеет значение NULL, в настоящее время нет консультативных подключений к объекту или произошла ошибка. Владелец рекомендаций отвечает за увеличение числа ссылок на указатель IEnumSTATDATA , который предоставляет этот метод. Вызывающий объект несет ответственность за вызов IUnknown::Release после завершения работы с указателем.

Возвращаемое значение

Этот метод возвращает значение S_OK при успешном завершении. Другие возможные возвращаемые значения включают следующее.

Код возврата	Описание
E_FAIL	Операция перечисления завершилась сбоем.
E_NOTIMPL	IOleAdviseHolder::EnumAdvise не реализован.

IOleAdviseHolder::EnumAdvise создает перечислитель, который можно использовать для перечисления установленных консультативных соединений объекта. Метод предоставляет указатель на интерфейс IEnumSTATDATA для этого перечислителя. Сведения о подключении рекомендаций для каждого подключения хранятся в структуре STATDATA , и перечислитель должен иметь возможность перечислять эти структуры.

Для этого метода единственными соответствующими элементами структуры являются pAdvise и dwConnection. Другие члены содержат информацию о данных. При вызове методов перечисления и при выполнении перечисления эффект регистрации или отзыва консультативных подключений на то, что должно быть перечислено, не определен.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	oleidl.h