Метод IMoniker::Enum (objidl.h)

Извлекает указатель на перечислитель для компонентов составного моникера.

Синтаксис

HRESULT Enum(
  [in]  BOOL         fForward,
  [out] IEnumMoniker **ppenumMoniker
);

Параметры

[in] fForward

Если задано значение TRUE, перечисляет моникеры слева направо. Если значение FALSE, выполняет перечисление справа налево.

[out] ppenumMoniker

Указатель на переменную указателя IEnumMoniker , которая получает указатель интерфейса на объект перечислителя для моникера. При успешном выполнении реализация должна вызвать AddRef для объекта перечислителя. Вызов Release лежит на вызывающем объекте. Если возникает ошибка или если моникер не содержит перечисляемых компонентов, реализация присваивает *ppenumMonikerзначение NULL.

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

Этот метод может возвращать стандартные возвращаемые значения E_OUTOFMEMORY, E_UNEXPECTED и S_OK.

Комментарии

Этот метод должен предоставлять указатель IEnumMoniker на перечислитель, который может перечислять компоненты моникера. Например, реализация метода IMoniker::Enum для универсального составного моникера создает перечислитель, который может определять отдельные моникеры, составляющие составной элемент , а метод IMoniker::Enum для моникера файла создает перечислитель, возвращающий моникер, представляющий каждый из компонентов в пути.

Примечания к вызывающим абонентам

Вызовите этот метод для проверки компонентов, составляющих составной моникер.

Примечания для разработчиков

Если новый класс моникера не имеет заметной внутренней структуры, реализация этого метода может просто вернуть S_OK и задать ppenumMonikerзначение NULL.

Примечания по реализации

Реализация Примечания
Антимоникер Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.
Моникер класса Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.
Файловый моникер Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.
Универсальный составной моникер В случае успешного выполнения этот метод возвращает S_OK и передает обратно перечислитель, который перечисляет моникеры компонентов, составляющие составной объект ; В противном случае метод возвращает E_OUTOFMEMORY.
Моникер элемента Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.
Моникер OBJREF Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.
Моникер указателя Этот метод возвращает E_NOTIMPL.
Моникер URL-адреса Этот метод возвращает S_OK и присваивает ppenumMonikerзначение NULL.

Требования

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

См. также раздел

IEnumMoniker

IMoniker