IEventSubscription::PutSubscriberProperty method (eventsys.h)

Article
02/22/2024

Writes a property and its value to the property bag to define subscriber context.

Syntax

HRESULT PutSubscriberProperty(
  [in] BSTR    bstrPropertyName,
  [in] VARIANT *propertyValue
);

Parameters

[in] bstrPropertyName

The name of the property whose value is to be written to the property bag. If the property is not in the property bag, this method adds it.

[in] propertyValue

The value of the property to be written to the property bag. If the property is already in the property bag, this method overwrites the current value.

Return value

This method can return the standard return values E_INVALIDARG, 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