IBroadcastFilter::put_Enabled

[This is preliminary documentation and subject to change.]

This method stores the value of the Enabled property.

HRESULT put_Enabled(
  BOOL Enable  // flag indicating whether this filter is enabled
);
 

Return Values

Returns an HRESULT indicating success or failure.

Remarks

The Enabled property specifies whether Announcement Listener is to call this filter when a new announcement arrives. A filter may be disabled but still reside in the filter list.

Filters must shutdown any threads the filter is using when Announcement Listener calls put_Enabled with the Enable argument set to VARIANT_FALSE. This allows Announcement Listener to properly shutdown.