Edit

IEventSubscription::GetSubscriberPropertyCollection method (eventsys.h)

  • Article

Retrieves a collection of properties and values stored in the subscriber property bag.

Syntax

HRESULT GetSubscriberPropertyCollection(
  [out, retval] IEventObjectCollection **collection
);

Parameters

[out, retval] collection

Address of a pointer to the IEventObjectCollection interface on an event object collection. This parameter cannot be NULL.

Return value

This method can return the standard return values E_INVALIDARG, E_POINTER, E_OUTOFMEMORY, E_UNEXPECTED, E_FAIL, and S_OK.

Remarks

A property bag is used to store information about the events the subscriber needs to be notified about. For example, if a subscriber to a sports ticker is to obtain only baseball scores, it could use the property bag in the subscription object to specify this restriction.

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

IEventSubscription