Метод IEventSystem::Remove (eventsys.h)

  • Статья

Удаляет один или несколько объектов подписки или событий из хранилища данных событий.

Синтаксис

HRESULT Remove(
  [in]  BSTR progID,
  [in]  BSTR queryCriteria,
  [out] int  *errorIndex
);

Параметры

[in] progID

Идентификатор ProgID удаляемого класса объекта. Это должен быть допустимый идентификатор класса объекта события. Этот параметр может иметь одно из следующих значений:

  • PROGID_EventClass
  • PROGID_EventClassCollection
  • PROGID_EventSubscription
  • PROGID_EventSubscriptionCollection

[in] queryCriteria

Условия запроса. Дополнительные сведения о формировании допустимого выражения для этого параметра см. в разделе Примечания ниже.

[out] errorIndex

Расположение ошибки в параметре queryCriteria , выраженное в виде смещения.

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

Этот метод может возвращать стандартные возвращаемые значения E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED и E_FAIL, а также следующие значения.

Код возврата Описание
S_OK
 Метод завершился успешно.
EVENT_E_QUERYSYNTAX
 При попытке вычисления строки запроса произошла синтаксическая ошибка.
EVENT_E_QUERYFIELD
 В строке запроса использовалось недопустимое имя поля.
EVENT_E_NOT_ALL_REMOVED
 Не все запрошенные объекты можно удалить.

Комментарии

Критерии запроса, заданные параметром queryCriteria , могут быть "ALL", чтобы указать запрос для всех объектов подписки, или логическое выражение, обозначающее одно или несколько условий, которым должен соответствовать объект подписки для включения в результат запроса. Допустимые выражения имеют следующую форму:

[НЕ] propertynamerelationalOperatorvalue. Допустимые реляционные операторы:

==, =, !=, <>, ~=. Допустимые значения: string,string, {GUID}, TRUE, FALSE, NULL.

Отдельные логические выражения можно объединить с помощью and или OR. Выражения могут быть вложены в круглые скобки, чтобы обеспечить определенный порядок вычисления.

Ниже приведены некоторые примеры допустимых критериев запроса.

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF}"

"EventClassID == {F89859D1-6565-11D1-88C8-0080C7D771BF} AND MethodName = 'StockPriceChange'"

Требования

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

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

IEventSystem