IPublisherFilter::PrepareToFire method (eventsys.h)

  • Article

Prepares a publisher filter to begin firing a filtered list of subscriptions using a provided firing control. The firing control is contained in the event class object.

This method is supported only for backward compatibility. Otherwise, you should use the methods of the IMultiInterfacePublisherFilter interface.

Syntax

HRESULT PrepareToFire(
  [in] BSTR           methodName,
  [in] IFiringControl *firingControl
);

Parameters

[in] methodName

The name of the event method to be fired.

[in] firingControl

A pointer to the IFiringControl interface on the firing control object.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following values.

Return code Description
S_OK
 The event class object is ready to fire the event.
EVENT_S_SOME_SUBSCRIBERS_FAILED
 An event was able to invoke some, but not all, of the subscribers.
EVENT_E_ALL_SUBSCRIBERS_FAILED
 An event was unable to invoke any of the subscribers.
EVENT_S_NOSUBSCRIBERS
 An event was published but there were no subscribers.
EVENT_E_QUERYSYNTAX
 A syntax error occurred while trying to evaluate a query string.
EVENT_E_QUERYFIELD
 An invalid field name was used in a query string.
EVENT_E_INTERNALEXCEPTION
 An unexpected exception was raised.
EVENT_E_INTERNALERROR
 An unexpected internal error was detected.
EVENT_E_INVALID_PER_USER_SID
 The owner SID on a per-user subscription does not exist.
EVENT_E_USER_EXCEPTION
 A user-supplied component or subscriber raised an exception.
EVENT_E_TOO_MANY_METHODS
 An interface has too many methods from which to fire events.
EVENT_E_MISSING_EVENTCLASS
 A subscription cannot be stored unless the event class for the subscription already exists.
EVENT_E_NOT_ALL_REMOVED
 Not all of the requested objects could be removed.
EVENT_E_COMPLUS_NOT_INSTALLED
 COM+ is required for this operation, but it is not installed.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header eventsys.h

See also

IMultiInterfacePublisherFilter

IPublisherFilter